Skip to main content

SSB Project CLI

Project description

SSB Project CLI

PyPI Status Python Version License

Read the documentation Tests Codecov

pre-commit Black

Features

Help text

  • 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

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]:

pip install ssb-project-cli

Releasing a new version

To release a new version of the CLI, run the following sequence.

git switch --create release main
poetry version <version>
git commit --message="<project> <version>" pyproject.toml
git push origin release

Contributing

Setup

  1. Install dependencies
  2. Install pre-commit hooks
  3. Run tests: nox -r (More information here)
  4. Run the help command: poetry run ssb-project --help

License

Distributed under the terms of the MIT license, SSB Project CLI is free and open source software.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ssb_project_cli-1.4.1.tar.gz (21.2 kB view hashes)

Uploaded Source

Built Distribution

ssb_project_cli-1.4.1-py3-none-any.whl (27.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page