xxxpython_package_namexxx ∞
xxxpackage_descriptionxxx.
Documentation for xxxpython_package_namexxx is hosted by Read the Docs ( development version and master version). The code lives on github. Please report any issues you find here.
Features ∞
Installation ∞
The easiest way to install xxxpython_package_namexxx is to use pip (here we show the install inside of a conda environment):
conda create -n xxxpython_package_namexxx python=3.7 pip
conda activate xxxpython_package_namexxx
pip install xxxpython_package_namexxx
Or you can clone the github repo and install from a local version of the code:
git clone git@github.com:thespacedoctor/xxxpython_package_namexxx.git
cd xxxpython_package_namexxx
python setup.py install
To upgrade to the latest version of xxxpython_package_namexxx use the command:
pip install xxxpython_package_namexxx --upgrade
To check installation was successful run xxxpython_package_namexxx -v. This should return the version number of the install.
Development ∞
If you want to tinker with the code, then install in development mode. This means you can modify the code from your cloned repo:
git clone git@github.com:thespacedoctor/xxxpython_package_namexxx.git
cd xxxpython_package_namexxx
python setup.py develop
Pull requests are welcomed!
Initialisation ∞
Before using xxxpython_package_namexxx you need to use the init command to generate a user settings file. Running the following creates a yaml settings file in your home folder under ~/.config/xxxpython_package_namexxx/xxxpython_package_namexxx.yaml:
xxxpython_package_namexxx init
The file is initially populated with xxxpython_package_namexxx’s default settings which can be adjusted to your preference.
If at any point the user settings file becomes corrupted or you just want to start afresh, simply trash the xxxpython_package_namexxx.yaml file and rerun xxxpython_package_namexxx init.
Todo List ∞
Todo
update key arguments values and definitions with defaults
update return values and definitions
update usage examples and text
update docstring text
check sublime snippet exists
clip any useful text to docs mindmap
regenerate the docs and check redendering of this docstring
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/python-package-frankenstein-template/envs/master/lib/python3.7/site-packages/xxxpython_package_namexxx-0.1-py3.7.egg/xxxpython_package_namexxx/docstring_test.py:docstring of xxxpython_package_namexxx.docstring_test.docsting_test, line 37.)
Todo
nice!
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/python-package-frankenstein-template/envs/master/lib/python3.7/site-packages/xxxpython_package_namexxx-0.1-py3.7.egg/xxxpython_package_namexxx/docstring_test.py:docstring of xxxpython_package_namexxx.docstring_test.docsting_test, line 52.)
Todo
update key arguments values and definitions with defaults
update return values and definitions
update usage examples and text
update docstring text
check sublime snippet exists
clip any useful text to docs mindmap
regenerate the docs and check redendering of this docstring
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/python-package-frankenstein-template/envs/master/lib/python3.7/site-packages/xxxpython_package_namexxx-0.1-py3.7.egg/xxxpython_package_namexxx/docstring_test.py:docstring of xxxpython_package_namexxx.docstring_test.docsting_test, line 37.)
Todo
nice!
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/python-package-frankenstein-template/envs/master/lib/python3.7/site-packages/xxxpython_package_namexxx-0.1-py3.7.egg/xxxpython_package_namexxx/docstring_test.py:docstring of xxxpython_package_namexxx.docstring_test.docsting_test, line 52.)
Todo
Make sure todo list is working. ✓
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/python-package-frankenstein-template/checkouts/master/docs/source/_template_.md, line 1.)
Release Notes ∞
API Reference ∞
Modules ∞
common tools used throughout package |
|
Testing the rendering of docstings - feel free to remove this module |
|
Unit testing tools |
Functions ∞
the database object for sherlock, setting up ssh tunnels and various database connections |
A-Z Index ∞
Modules
common tools used throughout package |
|
Testing the rendering of docstings - feel free to remove this module |
|
Unit testing tools |
Classes
Functions
the database object for sherlock, setting up ssh tunnels and various database connections |