Skip to main content

Generate complete configuration files for a Neurobagel deployment.

Project description

configure-nb

Main branch checks status Tests status Codecov Python versions static License

Configuration wizard for a Neurobagel deployment.

Development environment

Setting up a local development environment

  1. Set up a Python environment (using a tool such as venv).

  2. Clone the repository

    git clone https://github.com/neurobagel/configure-nb.git
    cd configure-nb
    
  3. Install the CLI and all development dependencies in editable mode:

    pip install -e ".[dev]"
    

Confirm that everything works by running the tests: pytest

Setting up code formatting and linting (recommended)

pre-commit is configured in the development environment for this repository, and can be set up to automatically run a number of code linters and formatters on any commit you make according to the consistent code style set for this project.

Inside the repo, run the following to install the configured pre-commit "hooks":

pre-commit install

pre-commit will now run automatically whenever you run git commit.

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

configure_nb-0.1.0.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

configure_nb-0.1.0-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

Details for the file configure_nb-0.1.0.tar.gz.

File metadata

  • Download URL: configure_nb-0.1.0.tar.gz
  • Upload date:
  • Size: 16.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for configure_nb-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b05c57707a9e54cc8d85d5412504bb360cd6985ef243e6ce368d9b89ba302b9b
MD5 3d2b1bef57ae1a2cc0e61eb08a444519
BLAKE2b-256 0478188db0fb8af5c396697cc1c980a259104b2bb7664b5a5ad639b3a4e3d58b

See more details on using hashes here.

File details

Details for the file configure_nb-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: configure_nb-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 12.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for configure_nb-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f0bb6f0ed7f35846c529a58fa2f4b4d49572e81591d21c3f7d95fc26e6f378bc
MD5 ce8d8074c233cc470a8d6f3aa0820420
BLAKE2b-256 04d929c4beae4fbcf6b42ade84b7d92eedcea383742a652340424a353deff7f9

See more details on using hashes here.

Supported by

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