A boilerplate environment for Python package development.
Project description
Chthonic
A boilerplate environment for Python package development.
Environment Setup
- Add any package dependencies to
setup.py
andrequirements.txt
. vagrant up
Using Jupyter Notebooks with Vagrant
- Enter the Vagrant environment with
vagrant ssh
. - Inside the Vagrant environment, run
jupyter notebook --ip=0.0.0.0
. - Copy the bottom-most URL printed to the console (e.g.,
http://127.0.0.1:8888/?token=5dibo
(the actual token will be much longer)). - Open your favorite web browser, paste in the URL, and go to it.
Package Development.
- Enter the Vagrant environment with
vagrant ssh
. - A venv for your package will be automatically loaded.
- Add project files in the appropriate directory (in this example, .py files in the
chthonic
folder will be packaged).
Packaging
- Enter the Vagrant environment with
vagrant ssh
. - Make sure your
README.md
is informative about your package. - Make sure all package dependencies have been added to
setup.py
. - The requirements for packaging are already installed in our venv by default.
python setup.py sdist
twine upload dist/*
(requires a pypi account).- Done!
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
chthonic-0.0.0.tar.gz
(1.7 kB
view hashes)