Skip to main content

Generated from aind-library-template

Project description

aind-slims-api

License Code Style semantic-release: angular Interrogate Coverage Python

This library is for pythonic access to data stored in the AIND SLIMS deployment. It is not meant to be a generic way to interact with SLIMS, but rather specific to how data is modeled in AIND's SLIMS instance.

Installation

To use the software, in the root directory, run

pip install -e .

To develop the code, run

pip install -e .[dev]

Usage

VScode

Example usage

Requires the pylance extension to be installed for similar functionality.

Contributing

Linters and testing

There are several libraries used to run linters, check documentation, and run tests.

  • Please test your changes using the coverage library, which will run the tests and log a coverage report:
coverage run -m unittest discover && coverage report
  • Use interrogate to check that modules, methods, etc. have been documented thoroughly:
interrogate .
  • Use flake8 to check that code is up to standards (no unused imports, etc.):
flake8 .
  • Use black to automatically format the code into PEP standards:
black .
  • Use isort to automatically sort import statements:
isort .

Pull requests

For internal members, please create a branch. For external members, please fork the repository and open a pull request from the fork. We'll primarily use Angular style for commit messages. Roughly, they should follow the pattern:

<type>(<scope>): <short summary>

where scope (optional) describes the packages affected by the code changes and type (mandatory) is one of:

  • build: Changes that affect build tools or external dependencies (example scopes: pyproject.toml, setup.py)
  • ci: Changes to our CI configuration files and scripts (examples: .github/workflows/ci.yml)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bugfix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • test: Adding missing tests or correcting existing tests

Semantic Release

The table below, from semantic release, shows which commit message gets you which release type when semantic-release runs (using the default configuration):

Commit message Release type
fix(pencil): stop graphite breaking when too much pressure applied Patch Fix Release, Default release
feat(pencil): add 'graphiteWidth' option Minor Feature Release
perf(pencil): remove graphiteWidth option

BREAKING CHANGE: The graphiteWidth option has been removed.
The default graphite width of 10mm is always used for performance reasons.
Major Breaking Release
(Note that the BREAKING CHANGE: token must be in the footer of the commit)

Documentation

To generate the rst files source files for documentation, run

sphinx-apidoc -o doc_template/source/ src 

Then to create the documentation HTML files, run

sphinx-build -b html doc_template/source/ doc_template/build/html

More info on sphinx installation can be found here.

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

aind_slims_api-0.1.12.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

aind_slims_api-0.1.12-py3-none-any.whl (22.0 kB view details)

Uploaded Python 3

File details

Details for the file aind_slims_api-0.1.12.tar.gz.

File metadata

  • Download URL: aind_slims_api-0.1.12.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for aind_slims_api-0.1.12.tar.gz
Algorithm Hash digest
SHA256 704f9a7a542407e5fab680409f2353e2bd8aa9eba89e9129fc97661550223fd1
MD5 193e8f3826a3544018b81ff3bc46e8d9
BLAKE2b-256 2753bdd48b140fcb913b4bf59862d89da2ba480adf2f6f459bd3e76d8f3d6386

See more details on using hashes here.

File details

Details for the file aind_slims_api-0.1.12-py3-none-any.whl.

File metadata

File hashes

Hashes for aind_slims_api-0.1.12-py3-none-any.whl
Algorithm Hash digest
SHA256 680717dfa02f4cbac1d9015a8a8c2e28fdfe03785080daf727002fc5129572d5
MD5 f1a3f1e9a789a031a1f41b85c095d454
BLAKE2b-256 033827d820b7928b0ac99765074a179ae75a3ee22f3567ef59cd0813ba880038

See more details on using hashes here.

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