# PDS Lasso Releasers
The PDS Lasso Releasers handle automatic "release" of software to artifact repositories, publishing packages for general availability. It's part of the "Lasso" family of products.
Please visit our website at: https://nasa-pds.github.io/lasso-releasers
It may have useful information for developers and end-users.
## Prerequisites
This software executes the `git` command and so `git` must be installed on the system prior to invoking this software.
## User Quickstart
Install with:
pip install lasso-releasers
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-releasers",
"name": "lasso.releasers",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "pds,planetary data,ci,automation,release",
"author": "PDS",
"author_email": "pds_operator@jpl.nasa.gov",
"download_url": "https://github.com/NASA-PDS/lasso-releasers/releases/",
"platform": null,
"description": "# PDS Lasso Releasers\n\nThe PDS Lasso Releasers handle automatic \"release\" of software to artifact repositories, publishing packages for general availability. It's part of the \"Lasso\" family of products.\n\nPlease visit our website at: https://nasa-pds.github.io/lasso-releasers\n\nIt may have useful information for developers and end-users.\n\n\n## Prerequisites\n\nThis software executes the `git` command and so `git` must be installed on the system prior to invoking this software.\n\n\n## User Quickstart\n\nInstall with:\n\n pip install lasso-releasers\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": "Release artifact publication automation for the Planetary Data System",
"version": "1.0.1",
"project_urls": {
"Download": "https://github.com/NASA-PDS/lasso-releasers/releases/",
"Homepage": "https://github.com/NASA-PDS/lasso-releasers"
},
"split_keywords": [
"pds",
"planetary data",
"ci",
"automation",
"release"
],
"urls": [
{
"comment_text": "\ud83e\udd20 Yee-haw! This here ar-tee-fact got done uploaded by the Roundup!",
"digests": {
"blake2b_256": "cff2388002d8154ec12281664f9ad99e24dde130ea085103ccd09fd17626e067",
"md5": "0ef7afe168ec6b4e30fd14854db900ad",
"sha256": "93ed77ea23b4c84dc7034053532f0d48b70110d6de1d9663cd24be0380033b0c"
},
"downloads": -1,
"filename": "lasso.releasers-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0ef7afe168ec6b4e30fd14854db900ad",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 16824,
"upload_time": "2024-03-04T18:37:40",
"upload_time_iso_8601": "2024-03-04T18:37:40.522310Z",
"url": "https://files.pythonhosted.org/packages/cf/f2/388002d8154ec12281664f9ad99e24dde130ea085103ccd09fd17626e067/lasso.releasers-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-04 18:37:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NASA-PDS",
"github_project": "lasso-releasers",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "lasso.releasers"
}
JSON
