# 🪐 Epitome
[](https://doi.org/10.5281/zenodo.5643446)
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](https://github.com/NASA-PDS/.github/blob/main/CODE_OF_CONDUCT.md). 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](https://www.jetbrains.com/pycharm/).
### Contributing
For information on how to contribute to NASA-PDS codebases please take a look at our [Contributing guidelines](https://github.com/NASA-PDS/.github/blob/main/CONTRIBUTING.md).
### 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](https://docs.python.org/3/tutorial/venv.html). 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](https://docs.python.org/3/library/unittest.html) 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
Raw data
{
"_id": null,
"home_page": "https://github.com/nasa-pds-engineering-node/epitome",
"name": "pds-epitome",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "pds,epitome,exemplar,prototype,demonstration,example,exhibit",
"author": "PDS",
"author_email": "pds_operator@jpl.nasa.gov",
"download_url": "https://github.com/nasa-pds-engineering-node/epitome/releases/",
"platform": null,
"description": "# \ud83e\ude90 Epitome\n\n[](https://doi.org/10.5281/zenodo.5643446)\n\nThis is a demonstration package that uses the PDS Python template repository.\n\nPlease visit our website at: https://nasa-pds-engineering-node.github.io/epitome\n\nIt has useful information for developers and end-users.\n\n\n## Prerequisites\n\nNone.\n\n\n## User Quickstart\n\nInstall with:\n\n pip install pds.epitome\n\nTo execute, run:\n\n pds-epitome\n\n\n## Code of Conduct\n\nAll users and developers of the NASA-PDS software are expected to abide by our [Code of Conduct](https://github.com/NASA-PDS/.github/blob/main/CODE_OF_CONDUCT.md). Please read this to ensure you understand the expectations of our community.\n\n\n## Development\n\nTo develop this project, use your favorite text editor, or an integrated development environment with Python support, such as [PyCharm](https://www.jetbrains.com/pycharm/).\n\n\n### Contributing\n\nFor information on how to contribute to NASA-PDS codebases please take a look at our [Contributing guidelines](https://github.com/NASA-PDS/.github/blob/main/CONTRIBUTING.md).\n\n\n### Installation\n\nInstall in editable mode and with extra developer dependencies into your virtual environment of choice:\n\n pip install --editable '.[dev]'\n\nConfigure the `pre-commit` hooks:\n\n pre-commit install && pre-commit install -t pre-push\n\n\n### Packaging\n\nTo isolate and be able to re-produce the environment for this package, you should use a [Python Virtual Environment](https://docs.python.org/3/tutorial/venv.html). To do so, run:\n\n python -m venv venv\n\nThen exclusively use `venv/bin/python`, `venv/bin/pip`, etc.\n\nIf you have `tox` installed and would like it to create your environment and install dependencies for you run:\n\n tox --devenv <name you'd like for env> -e dev\n\nDependencies for development are specified as the `dev` `extras_require` in `setup.cfg`; they are installed into the virtual environment as follows:\n\n pip install --editable '.[dev]'\n\nAll the source code is in a sub-directory under `src`.\n\n\n### Tooling\n\nThe `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:\n\n tox -e lint\n\n\n### Tests\n\nThis section describes testing for your package.\n\nA complete \"build\" including test execution, linting (`mypy`, `black`, `flake8`, etc.), and documentation build is executed via:\n\n tox\n\n\n#### Unit tests\n\nYour project should have built-in unit tests, functional, validation, acceptance, etc., tests.\n\nFor unit testing, check out the [unittest](https://docs.python.org/3/library/unittest.html) module, built into Python 3.\n\nTests objects should be in packages `test` modules or preferably in project 'tests' directory which mirrors the project package structure.\n\nOur unit tests are launched with command:\n\n pytest\n\nIf you want your tests to run automatically as you make changes start up `pytest` in watch mode with:\n\n ptw\n\n\n## Build\n\n pip install wheel\n python setup.py sdist bdist_wheel\n",
"bugtrack_url": null,
"license": "apache-2.0",
"summary": "A small demonstration of the PDS Python repository template",
"version": "3.3.1",
"project_urls": {
"Download": "https://github.com/nasa-pds-engineering-node/epitome/releases/",
"Homepage": "https://github.com/nasa-pds-engineering-node/epitome"
},
"split_keywords": [
"pds",
"epitome",
"exemplar",
"prototype",
"demonstration",
"example",
"exhibit"
],
"urls": [
{
"comment_text": "\ud83e\udd20 Yee-haw! This here ar-tee-fact got done uploaded by the Roundup!",
"digests": {
"blake2b_256": "01b311be8e78f7486e6774633c772867193b5e011d0b74d94dd9089eae2fa2cc",
"md5": "b8bb710a7a04a89da386261023040132",
"sha256": "643ea6903c6e943cf3442d61d780249044b72fc4ce355203e1707fa55ea01d70"
},
"downloads": -1,
"filename": "pds_epitome-3.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b8bb710a7a04a89da386261023040132",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 9965,
"upload_time": "2023-12-07T14:52:36",
"upload_time_iso_8601": "2023-12-07T14:52:36.830351Z",
"url": "https://files.pythonhosted.org/packages/01/b3/11be8e78f7486e6774633c772867193b5e011d0b74d94dd9089eae2fa2cc/pds_epitome-3.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-07 14:52:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nasa-pds-engineering-node",
"github_project": "epitome",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pds-epitome"
}
JSON
