Skip to content

Commit

Permalink
Merge pull request #4 from AllenNeuralDynamics/dyf-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
patricklatimer authored May 8, 2024
2 parents 1b2ba18 + 4cf7151 commit 3c933df
Showing 1 changed file with 1 addition and 8 deletions.
9 changes: 1 addition & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,7 @@
![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen?logo=codecov)
![Python](https://img.shields.io/badge/python->=3.7-blue?logo=python)



## Usage
- To use this template, click the green `Use this template` button and `Create new repository`.
- After github initially creates the new repository, please wait an extra minute for the initialization scripts to finish organizing the repo.
- To enable the automatic semantic version increments: in the repository go to `Settings` and `Collaborators and teams`. Click the green `Add people` button. Add `svc-aindscicomp` as an admin. Modify the file in `.github/workflows/tag_and_publish.yml` and remove the if statement in line 10. The semantic version will now be incremented every time a code is committed into the main branch.
- To publish to PyPI, enable semantic versioning and uncomment the publish block in `.github/workflows/tag_and_publish.yml`. The code will now be published to PyPI every time the code is committed into the main branch.
- The `.github/workflows/test_and_lint.yml` file will run automated tests and style checks every time a Pull Request is opened. If the checks are undesired, the `test_and_lint.yml` can be deleted. The strictness of the code coverage level, etc., can be modified by altering the configurations in the `pyproject.toml` file and the `.flake8` file.
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
Expand Down

0 comments on commit 3c933df

Please sign in to comment.