Skip to main content

Copies zarr archives from an acquisition frontend to a different disk, using filesystem watching and lockfiles to allow copying during acquisition.

Project description

softcopy

Release Build status codecov Commit activity License

Copies zarr archives from an acquisition frontend to a different disk, using filesystem watching and lockfiles to allow copying during acquisition.

Getting started with your project

1. Create a New Repository

First, create a repository on GitHub with the same name as this project, and then run the following commands:

git init -b main
git add .
git commit -m "init commit"
git remote add origin git@github.com:royerlab/softcopy.git
git push -u origin main

2. Set Up Your Development Environment

Then, install the environment and the pre-commit hooks with

make install

This will also generate your uv.lock file

3. Run the pre-commit hooks

Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:

uv run pre-commit run -a

4. Commit the changes

Lastly, commit the changes made by the two steps above to your repository.

git add .
git commit -m 'Fix formatting issues'
git push origin main

You are now ready to start development on your project! The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.

To finalize the set-up for publishing to PyPI, see here. For activating the automatic documentation with MkDocs, see here. To enable the code coverage reports, see here.

Releasing a new version

  • Create an API Token on PyPI.
  • Add the API Token to your projects secrets with the name PYPI_TOKEN by visiting this page.
  • Create a new release on Github.
  • Create a new tag in the form *.*.*.

For more details, see here.


Repository initiated with fpgmaas/cookiecutter-uv.

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

softcopy-0.0.3.tar.gz (22.3 kB view details)

Uploaded Source

Built Distribution

softcopy-0.0.3-py3-none-any.whl (21.6 kB view details)

Uploaded Python 3

File details

Details for the file softcopy-0.0.3.tar.gz.

File metadata

  • Download URL: softcopy-0.0.3.tar.gz
  • Upload date:
  • Size: 22.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.7

File hashes

Hashes for softcopy-0.0.3.tar.gz
Algorithm Hash digest
SHA256 8d45c3b25d1c142ecd291642ed7d26284488272e06c0f3a290a4741e7f4e5e61
MD5 6816eba878411b73386e2c5472433315
BLAKE2b-256 4bbd15c479b173561f004e12e91b284776236c051f9b15d6df4506f52989aa82

See more details on using hashes here.

File details

Details for the file softcopy-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: softcopy-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 21.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.7

File hashes

Hashes for softcopy-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 afd70c0fe75fd3dc702493cb3e759cf9ce7c131c4935f28993ef766e26b0d3e3
MD5 00c27ae7b4f60578c7d2e160b8a1dc7b
BLAKE2b-256 22dd28dd3d618f6256f15fe4b950f9d53d4049f711e2d4815ffdd25426c0c612

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