Devloper shell for easy startup...
Project description
A "dev-shell" for Python projects ;)
This small project is intended to improve the start-up for collaborators.
The idea is to make the project setup as simple as possible. Just clone the sources and start a script and you're done ;)
Run Tests? Just start the script and call the "run test command".
The "dev-shell" is the base to create a CLI and a shell. It also
It also shows how to make a project bootstrap as simply as possible, e.g.:
~$ git clone https://github.com/jedie/dev-shell.git
~$ cd dev-shell
~/dev-shell$ ./dev-shell.py pytest
How it works
First start of the Python script ./dev-shell.py will bootstrap:
- Generate a Python virtual environment (in short:
venv
) - Install poetry
- Install project dependencies and the project himself
The output on first bootstrap start looks like:
~/dev-shell$ ./dev-shell.py
Create venv here: ~/dev-shell/.venv
Collecting pip
...
Successfully installed pip-21.0.1
Collecting poetry
...
Installing dependencies from lock file
Package operations: 31 installs, 1 update, 0 removals
...
Installing the current project: dev-shell (0.0.1alpha0)
Developer shell - dev_shell - v0.0.1alpha0
Documented commands (use 'help -v' for verbose/'help <topic>' for details):
Publish
=======
publish
Tests
=====
pytest
...
(dev_shell) quit
~/dev-shell$
The first bootstrap start takes a few seconds. Each later startup detects the existing virtualenv and is very fast:
~/dev-shell$ ./dev-shell.py
Developer shell - dev_shell - v0.0.1alpha0
(dev_shell)
~/dev-shell$ ./dev-shell.py --update
To update existing virtualenv, call with --update
:
~/dev-shell$ ./dev-shell.py --update
Or just delete /.venv/
and start dev-shell.py
;)
compatibility
dev-shell version | OS | Python version |
---|---|---|
v0.0.1 | Linux + MacOS + Windows | 3.9, 3.8, 3.7 |
See also github test configuration: .github/workflows/test.yml
History
- dev
- TBC
- v0.0.2 - 2021-03-19
- refactor colorful shortcuts
- display subprocess calls with separated colors
- v0.0.1 - 2021-03-19
- first "useable" version
Project links
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dev_shell-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69a44264b4f269a3e568de8b37e11e112860745f77b0b08e8ffeb14061be68ac |
|
MD5 | 6b0a67b7be90ffa8d0632d7753cb4c4f |
|
BLAKE2b-256 | 9060c176c72c2fe82fd6202ba1c1c2e0901c901b01d74c52afa8c2bef567aa37 |