Lightweight Python library for assembling and analysing
financial data. Wraps
matplotlib for maximum
ease of use. Included are tools for generating features
and labels for machine learning algorithms.
PyNance will also work with other versions of Python and Python packages. To verify that it works with yours, simply run the unit tests for data retrieval, then try making some charts with sample data you retrieve.
Additional dependencies for the
Building the docs
To build the documentation using Sphinx outside of a virtual Python environment,
./doc and type
make html. If you are using a virtual environment for any
dependencies, you will need to add
numpydoc to the virtual
environment before building the documentation. Explanation
In other words, from within your virtual environment:
$ pip install sphinx $ pip install numpydoc
Then build the documentation using
To set up your virtual environment for development:
$ mkvirtualenv -p /usr/local/bin/python pn-dev $ python setup.py develop
Release a new version
develop has all desired substantive changes, it is
time to release the next version. This involves:
- create the new version and push it to Pypi
- reorganize the documentation in the
Note on building the documentation
A note applying to both steps: The environment in which you
build the documentation must include the external dependencies
pandas, etc.) mentioned above. Sphinx actually checks
for the presence of dependencies and will fail to build the
documentation if they are missing.
Create the new version
develop verify that all desired changes have been merged and that
the documentation is up to date. Then:
Change the release version in
./doc/source/conf.pyto the numbers desired for the version you are about to publish.
Build the documentation:
$ cd ./doc $ make html
Merge to master.
Tag the release in GitHub.
Publish to PyPi.
Push the documentation to pynance.net:
master should now be the same. In preparation for the next
release (in the more distant future), you should now re-organize the
documentation so that what was just committed
is archived and new documentation can be generated, as described in the following section.
Reorganize the documentation
As example, let's say the version just committed is version
Move current public html to an archive directory:
$ cd ./doc $ make archhtml ARCHDIR="3.1.4"
Add a link to version
./doc/source/index.rstunder 'Prior Versions'
Change version number in
Rebuild current documentation:
$ make html
Write new documentation to public directory:
$ make pubhtml