Metadata-Version: 2.4
Name: ssb-project-cli
Version: 1.8.2
Summary: SSB Project CLI
Author: Statistics Norway
Author-email: Statistics Norway <stat-dev@ssb.no>
License-Expression: MIT
Classifier: Development Status :: 4 - Beta
Requires-Dist: typer==0.19.2
Requires-Dist: click<8.4
Requires-Dist: gitpython>=3.1.59
Requires-Dist: pygithub>=1.55
Requires-Dist: cruft>=2.11.1
Requires-Dist: rich>=12.5.1
Requires-Dist: requests>=2.33.0
Requires-Dist: questionary>=1.10.0
Requires-Dist: psutil>=5.9.4
Requires-Dist: kvakk-git-tools>=2.6.1
Requires-Dist: poetry>=2.0
Requires-Dist: jupyter-client>=8.3.1
Requires-Dist: ipykernel>=6.25.2
Requires-Dist: tomli>=2.0.1
Requires-Python: >=3.10
Project-URL: homepage, https://github.com/statisticsnorway/ssb-project-cli
Project-URL: repository, https://github.com/statisticsnorway/ssb-project-cli
Project-URL: documentation, https://ssb-project-cli.readthedocs.io
Project-URL: Changelog, https://github.com/statisticsnorway/ssb-project-cli/releases
Description-Content-Type: text/markdown

# SSB Project CLI

[![PyPI](https://img.shields.io/pypi/v/ssb-project-cli.svg)][pypi status]
[![Status](https://img.shields.io/pypi/status/ssb-project-cli.svg)][pypi status]
[![Python Version](https://img.shields.io/pypi/pyversions/ssb-project-cli)][pypi status]
[![License](https://img.shields.io/pypi/l/ssb-project-cli)][license]

[![Read the documentation](https://img.shields.io/badge/docs-Github%20Pages-purple)](https://statisticsnorway.github.io/ssb-project-cli/)
[![Tests](https://github.com/statisticsnorway/ssb-project-cli/workflows/Tests/badge.svg)][tests]
[![Codecov](https://codecov.io/gh/statisticsnorway/ssb-project-cli/branch/main/graph/badge.svg)][codecov]

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][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

![Help text](/docs/assets/images/cli_help_screenshot.png)

- 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
uv version <version>
```

```console
git commit --message="<project> <version>" pyproject.toml uv.lock
```

```console
git push origin release
```

## Contributing

### Setup

1. [Install uv](https://docs.astral.sh/uv/getting-started/installation/)
1. Install dependencies: `uv sync --all-groups`
1. Install pre-commit hooks: `uv run pre-commit install`
1. Run tests: `uv run nox -r`
1. Run the help command: `uv 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
