# PDS Lasso Requirements
The PDS Lasso Requirements generates requirements reports of software projects based on GitHub issues. It's part of the "Lasso" family of products.
Please visit our website at: https://nasa-pds.github.io/lasso-requirements
It may have useful information for developers and end-users.
## Prerequisites
Installing this software requires `git` to be present on the target systme.
## User Quickstart
Install with:
pip install lasso-requirements
To execute, run:
(put your run commands here)
## 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
pre-commit install -t prepare-commit-msg
pre-commit install -t commit-msg
These hooks check code formatting and also aborts commits that contain secrets such as passwords or API keys. However, a one time setup is required in your global Git configuration. See [the wiki entry on Git Secrets](https://github.com/NASA-PDS/nasa-pds.github.io/wiki/Git-and-Github-Guide#git-secrets) to learn how.
### 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:
python3 -m venv venv
Then exclusively use `venv/bin/python`, `venv/bin/pip`, etc. Or, "activate" the virtual environment by sourcing the appropriate script in the `venv/bin` directory.
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
Raw data
{
"_id": null,
"home_page": "https://github.com/NASA-PDS/lasso-requirements",
"name": "lasso.requirements",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "pds,planetary data,ci,automation,requirements,reporting",
"author": "PDS",
"author_email": "pds_operator@jpl.nasa.gov",
"download_url": "https://files.pythonhosted.org/packages/a0/c3/4c6728ad072aa456d6d848b831b7e284864e3512154879c7898241b5cf59/lasso.requirements-1.0.0.tar.gz",
"platform": null,
"description": "# PDS Lasso Requirements\n\nThe PDS Lasso Requirements generates requirements reports of software projects based on GitHub issues. It's part of the \"Lasso\" family of products.\n\nPlease visit our website at: https://nasa-pds.github.io/lasso-requirements\n\nIt may have useful information for developers and end-users.\n\n\n## Prerequisites\n\nInstalling this software requires `git` to be present on the target systme.\n\n\n## User Quickstart\n\nInstall with:\n\n pip install lasso-requirements\n\n\nTo execute, run:\n\n (put your run commands here)\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\n pre-commit install -t pre-push\n pre-commit install -t prepare-commit-msg\n pre-commit install -t commit-msg\n\nThese hooks check code formatting and also aborts commits that contain secrets such as passwords or API keys. However, a one time setup is required in your global Git configuration. See [the wiki entry on Git Secrets](https://github.com/NASA-PDS/nasa-pds.github.io/wiki/Git-and-Github-Guide#git-secrets) to learn how.\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 python3 -m venv venv\n\nThen exclusively use `venv/bin/python`, `venv/bin/pip`, etc. Or, \"activate\" the virtual environment by sourcing the appropriate script in the `venv/bin` directory.\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",
"bugtrack_url": null,
"license": "apache-2.0",
"summary": "Requirements report generation for the Planetary Data System",
"version": "1.0.0",
"project_urls": {
"Download": "https://github.com/NASA-PDS/lasso-requirements/releases/",
"Homepage": "https://github.com/NASA-PDS/lasso-requirements"
},
"split_keywords": [
"pds",
"planetary data",
"ci",
"automation",
"requirements",
"reporting"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9e8020ea8d46c9df4ac47b9375a8f447c0866166068351f7a5cee9c2beb04bc5",
"md5": "73297a85e00d083caf8dd3b8828a601d",
"sha256": "e21e24b98658bf0603ab6ff474d200caad905e621cd44ac2878fcbb1388a1e30"
},
"downloads": -1,
"filename": "lasso.requirements-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "73297a85e00d083caf8dd3b8828a601d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 16237,
"upload_time": "2023-07-19T14:55:19",
"upload_time_iso_8601": "2023-07-19T14:55:19.980088Z",
"url": "https://files.pythonhosted.org/packages/9e/80/20ea8d46c9df4ac47b9375a8f447c0866166068351f7a5cee9c2beb04bc5/lasso.requirements-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a0c34c6728ad072aa456d6d848b831b7e284864e3512154879c7898241b5cf59",
"md5": "12fdff3edb4cec14dbf673efbb830a6f",
"sha256": "c8071ca018f628b6f671fcc1eb62194beff5ab88774e6822f569646ff2d517d2"
},
"downloads": -1,
"filename": "lasso.requirements-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "12fdff3edb4cec14dbf673efbb830a6f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 15242,
"upload_time": "2023-07-19T14:55:21",
"upload_time_iso_8601": "2023-07-19T14:55:21.189414Z",
"url": "https://files.pythonhosted.org/packages/a0/c3/4c6728ad072aa456d6d848b831b7e284864e3512154879c7898241b5cf59/lasso.requirements-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-19 14:55:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NASA-PDS",
"github_project": "lasso-requirements",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "lasso.requirements"
}
JSON
