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.5.tar.gz (22.6 kB view details)

Uploaded Source

Built Distribution

softcopy-0.0.5-py3-none-any.whl (21.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: softcopy-0.0.5.tar.gz
  • Upload date:
  • Size: 22.6 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.5.tar.gz
Algorithm Hash digest
SHA256 f7e43483ffaa999c2dcb19d33962484db9b9369e962a1c74d06056f37829103a
MD5 0161818e3a0c2bbe4bc549e8c0b50366
BLAKE2b-256 a3ca0f169f0a8eff536508cf89512da92cec1b83590f70381046d3bb7d5f76c3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: softcopy-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 21.9 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 00091048811c96c1439a73e07da8d6bf8c91d813e1eb62f86cd232c30dee748d
MD5 0f82b8b46169bb00e9494fbadfb09abe
BLAKE2b-256 c8a5a7170f5723732fec1c040339dd327155e4253fd0a17a9ae462ec7b053b8c

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