https://github.com/statisticsnorway/ssb-project-cli

Create a new project quickly and easily, following SSBs guidelines for quality and security
https://github.com/statisticsnorway/ssb-project-cli

pypi

Last synced: 15 days ago
JSON representation

Create a new project quickly and easily, following SSBs guidelines for quality and security

• Host: GitHub
• URL: https://github.com/statisticsnorway/ssb-project-cli
• Owner: statisticsnorway
• License: mit
• Created: 2022-09-20T08:51:40.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-09T11:48:03.000Z (22 days ago)
• Last Synced: 2024-12-10T18:30:42.569Z (21 days ago)
• Topics: pypi
• Language: Python
• Homepage:
• Size: 1.94 MB
• Stars: 2
• Watchers: 19
• Forks: 1
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# 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

poetry version 

```

```console

git commit --message=" " 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.

[license]: https://github.com/statisticsnorway/ssb-project-cli/blob/main/LICENSE