# SSB Project CLI
[][pypi status]
[][pypi status]
[][pypi status]
[][license]
[](https://statisticsnorway.github.io/ssb-project-cli/)
[][tests]
[][codecov]
[][pre-commit]
[][black]
[pypi status]: https://pypi.org/project/ssb-project-cli/
[tests]: https://github.com/statisticsnorway/ssb-project-cli/actions?workflow=Tests
[codecov]: https://app.codecov.io/gh/statisticsnorway/ssb-project-cli
[pre-commit]: https://github.com/pre-commit/pre-commit
[black]: https://github.com/psf/black
## Features
- Create a new project quickly and easily with `ssb-project create`.
- Your colleagues can quickly get started when you share the project with them with `ssb-project build`.
- Includes:
- Local directory structure
- Virtual Environment
- Kernel for use on Jupyter
- Github repo (if desired)
- The project will follow the most recent SSB guidelines for security and quality.
- It will always be possible to update existing projects as guidelines change.
:sparkles: Now allows specifying _any_ Cookiecutter template which uses Poetry, for example
```shell
ssb-project create my-project --template-git-url https://github.com/cjolowicz/cookiecutter-hypermodern-python
```
## Installation
You can install _SSB Project CLI_ via [pip] from [PyPI]:
```console
pip install ssb-project-cli
```
## Releasing a new version
To release a new version of the CLI, run the following sequence.
```console
git switch --create release main
```
```console
poetry version <version>
```
```console
git commit --message="<project> <version>" pyproject.toml
```
```console
git push origin release
```
## Contributing
### Setup
1. [Install dependencies](https://cookiecutter-hypermodern-python.readthedocs.io/en/latest/guide.html#installation)
1. [Install pre-commit hooks](https://cookiecutter-hypermodern-python.readthedocs.io/en/latest/guide.html#running-pre-commit-from-git)
1. Run tests: `nox -r` ([More information here](https://cookiecutter-hypermodern-python.readthedocs.io/en/latest/guide.html#using-nox))
1. Run the help command: `poetry run ssb-project --help`
## License
Distributed under the terms of the [MIT license][license],
_SSB Project CLI_ is free and open source software.
<!-- github-only -->
[license]: https://github.com/statisticsnorway/ssb-project-cli/blob/main/LICENSE
Raw data
{
"_id": null,
"home_page": "https://github.com/statisticsnorway/ssb-project-cli",
"name": "ssb-project-cli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<3.12",
"maintainer_email": "",
"keywords": "",
"author": "Statistics Norway",
"author_email": "stat-dev@ssb.no",
"download_url": "https://files.pythonhosted.org/packages/b7/96/483ed1419794cf1d4f4c2bdd4ac724db9e353736051edd4771b82ea1c8ef/ssb_project_cli-1.3.9.tar.gz",
"platform": null,
"description": "# SSB Project CLI\n\n[][pypi status]\n[][pypi status]\n[][pypi status]\n[][license]\n\n[](https://statisticsnorway.github.io/ssb-project-cli/)\n[][tests]\n[][codecov]\n\n[][pre-commit]\n[][black]\n\n[pypi status]: https://pypi.org/project/ssb-project-cli/\n[tests]: https://github.com/statisticsnorway/ssb-project-cli/actions?workflow=Tests\n[codecov]: https://app.codecov.io/gh/statisticsnorway/ssb-project-cli\n[pre-commit]: https://github.com/pre-commit/pre-commit\n[black]: https://github.com/psf/black\n\n## Features\n\n\n\n- Create a new project quickly and easily with `ssb-project create`.\n- Your colleagues can quickly get started when you share the project with them with `ssb-project build`.\n- Includes:\n - Local directory structure\n - Virtual Environment\n - Kernel for use on Jupyter\n - Github repo (if desired)\n- The project will follow the most recent SSB guidelines for security and quality.\n- It will always be possible to update existing projects as guidelines change.\n\n:sparkles: Now allows specifying _any_ Cookiecutter template which uses Poetry, for example\n\n```shell\nssb-project create my-project --template-git-url https://github.com/cjolowicz/cookiecutter-hypermodern-python\n```\n\n## Installation\n\nYou can install _SSB Project CLI_ via [pip] from [PyPI]:\n\n```console\npip install ssb-project-cli\n```\n\n## Releasing a new version\n\nTo release a new version of the CLI, run the following sequence.\n\n```console\ngit switch --create release main\n```\n\n```console\npoetry version <version>\n```\n\n```console\ngit commit --message=\"<project> <version>\" pyproject.toml\n```\n\n```console\ngit push origin release\n```\n\n## Contributing\n\n### Setup\n\n1. [Install dependencies](https://cookiecutter-hypermodern-python.readthedocs.io/en/latest/guide.html#installation)\n1. [Install pre-commit hooks](https://cookiecutter-hypermodern-python.readthedocs.io/en/latest/guide.html#running-pre-commit-from-git)\n1. Run tests: `nox -r` ([More information here](https://cookiecutter-hypermodern-python.readthedocs.io/en/latest/guide.html#using-nox))\n1. Run the help command: `poetry run ssb-project --help`\n\n## License\n\nDistributed under the terms of the [MIT license][license],\n_SSB Project CLI_ is free and open source software.\n\n<!-- github-only -->\n\n[license]: https://github.com/statisticsnorway/ssb-project-cli/blob/main/LICENSE\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "SSB Project CLI",
"version": "1.3.9",
"project_urls": {
"Changelog": "https://github.com/statisticsnorway/ssb-project-cli/releases",
"Documentation": "https://ssb-project-cli.readthedocs.io",
"Homepage": "https://github.com/statisticsnorway/ssb-project-cli",
"Repository": "https://github.com/statisticsnorway/ssb-project-cli"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4c674144f40d8c2fc43a25e8e8639d2c67384fc6679d8fd9b1d1020fe9cbacb8",
"md5": "2a524d50f6164d5c7573d90d2e918570",
"sha256": "8e020eff7d3c2b83e86fd70f5cefee9d1fcf9af125e8cb6eedcdf8f95fc99223"
},
"downloads": -1,
"filename": "ssb_project_cli-1.3.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2a524d50f6164d5c7573d90d2e918570",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<3.12",
"size": 27424,
"upload_time": "2023-12-08T13:23:50",
"upload_time_iso_8601": "2023-12-08T13:23:50.639083Z",
"url": "https://files.pythonhosted.org/packages/4c/67/4144f40d8c2fc43a25e8e8639d2c67384fc6679d8fd9b1d1020fe9cbacb8/ssb_project_cli-1.3.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b796483ed1419794cf1d4f4c2bdd4ac724db9e353736051edd4771b82ea1c8ef",
"md5": "c2db3089d7258f27dc2311f6b1dbd45f",
"sha256": "6b70b1f7cbb88c6c9562204b37a3014d10ebb05277819b91403f3ab121b8070b"
},
"downloads": -1,
"filename": "ssb_project_cli-1.3.9.tar.gz",
"has_sig": false,
"md5_digest": "c2db3089d7258f27dc2311f6b1dbd45f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<3.12",
"size": 20745,
"upload_time": "2023-12-08T13:23:52",
"upload_time_iso_8601": "2023-12-08T13:23:52.358942Z",
"url": "https://files.pythonhosted.org/packages/b7/96/483ed1419794cf1d4f4c2bdd4ac724db9e353736051edd4771b82ea1c8ef/ssb_project_cli-1.3.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-08 13:23:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "statisticsnorway",
"github_project": "ssb-project-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ssb-project-cli"
}
JSON
