The quickest way to get started developing this package is to clone it and build it out:
git clone https://github.com/NASA-PDS/pds-deep-archive.git cd pds-deep-archive python3 -m venv venv venv/bin/pip install --editable '.[dev]'
The above series of commands assume you have the corresponding development tools and familiarity with invoking them from the command line or “terminal”. Shells, operating systems, and command invocation varies.
At this point, you’ll have the
pds-deep-registry-archive, and other programs ready to run as
that’s set up to use source Python code under
src. Changes you make to
the code are reflected in immediately.
The documentation is in
docs/source, formatted as reStructuredText and
structured with Sphinx. To build the HTML from the documentation, run
venv/bin/python setup.py build_sphinx. It will write HTML output to
Commits back to GitHub will trigger workflows in GitHub Actions that re-publish the project website as well as send artifacts to the testing Python Package Index via the “unstable” workflow. The official Python Package Index gets updated only with official release tags via the “stable” workflow.
The code base finally includes unit and functional tests. Once you’ve run
venv/bin/pip install --editable '.[dev]' you can run the entire test suite
That’s what our continuous integration is for; the “stable” workflow