A small demonstration of the PDS Python repository template
Project description
🪐 Epitome
This is a demonstration package that uses the PDS Python template repository.
Please visit our website at: https://nasa-pds-engineering-node.github.io/epitome
It has useful information for developers and end-users.
Prerequisites
None.
User Quickstart
Install with:
pip install pds.epitome
To execute, run:
pds-epitome
Code of Conduct
All users and developers of the NASA-PDS software are expected to abide by our Code of Conduct. Please read this to ensure you understand the expectations of our community.
Development
To develop this project, use your favorite text editor, or an integrated development environment with Python support, such as PyCharm.
Contributing
For information on how to contribute to NASA-PDS codebases please take a look at our Contributing guidelines.
Installation
Install in editable mode and with extra developer dependencies into your virtual environment of choice:
pip install --editable '.[dev]'
Configure the pre-commit hooks:
pre-commit install && pre-commit install -t pre-push
Packaging
To isolate and be able to re-produce the environment for this package, you should use a Python Virtual Environment. To do so, run:
python -m venv venv
Then exclusively use venv/bin/python, venv/bin/pip, etc.
If you have tox installed and would like it to create your environment and install dependencies for you run:
tox --devenv <name you'd like for env> -e dev
Dependencies for development are specified as the dev extras_require in setup.cfg; they are installed into the virtual environment as follows:
pip install --editable '.[dev]'
All the source code is in a sub-directory under src.
Tooling
The dev extras_require included in the template repo installs black, flake8 (plus some plugins), and mypy along with default configuration for all of them. You can run all of these (and more!) with:
tox -e lint
Tests
This section describes testing for your package.
A complete "build" including test execution, linting (mypy, black, flake8, etc.), and documentation build is executed via:
tox
Unit tests
Your project should have built-in unit tests, functional, validation, acceptance, etc., tests.
For unit testing, check out the unittest module, built into Python 3.
Tests objects should be in packages test modules or preferably in project 'tests' directory which mirrors the project package structure.
Our unit tests are launched with command:
pytest
If you want your tests to run automatically as you make changes start up pytest in watch mode with:
ptw
Build
pip install wheel
python setup.py sdist bdist_wheel
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 Distributions
Built Distribution
Hashes for pds_epitome-3.3.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 643ea6903c6e943cf3442d61d780249044b72fc4ce355203e1707fa55ea01d70 |
|
| MD5 | b8bb710a7a04a89da386261023040132 |
|
| BLAKE2b-256 | 01b311be8e78f7486e6774633c772867193b5e011d0b74d94dd9089eae2fa2cc |
