Skip to main content

Template README.md
This file is from the template repository. Rewrite it for your own package.

Python Package Setup

Setup Base

To install required pip modules for generate_toml.py, run

source scripts/setup_base.sh

User Setup

  • go to generate_toml.py file, and complete the setup in the User Setup session.
options = Options(
    # Will you use the discussion session in your repo?
    discussion=False
)

# Define the general information of your package
kwargs = Kwargs(
    name_space="None",
    module_name="None",
    description="None",
)

If you wrote all the information, run

python generate_toml.py

Template

If you want to understand the generation process, check the template variable in generate_toml.py.

Setup Env

Prerequisite

Finish User Setup first. Of course, conda command must be available.

Setup Env

Run

source scripts/setup_env.sh

steps

  • create an conda environment named as your $MODULE_NAME
  • activate the environment.
  • install requirements.txt

Generate Private Env

Generate a private repository in this repo. I recommend you to write all the unstructured codes in this repo.

source scripts/generate_dev_repo.sh

It will ask you the name of your repo, and then, generate a repo named f'{your_repo_name}-dev'.

Usage Tip

If you wrote your codes in a wrong branch,

  • backup the files to the dev repo
  • remove changes in your main(not main branch) repo
  • move to your correct branch
  • place back the backup codes

Workflows

I currently setup test and release workflows.

Test

If you make a PR with the patterns [ main, develop, 'release/', 'feature/' ],

It will perform your unittest in ["3.9", "3.10", "3.11"]

Release

required secret : PYPI_API_TOKEN

I usually make PRs only when I start release branches. release workflow is not conducted automatically. If you think your branch is ready to be published,

Metadata

Release files for crimson-nbval-coverage 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for crimson-nbval-coverage 0.1.0
File Size Uploaded Provenance Actions
crimson_nbval_coverage-0.1.0.tar.gz 5.8 kB Without provenance Details for crimson_nbval_coverage-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for crimson-nbval-coverage 0.1.0
File Interpreter ABI Platform Actions
crimson_nbval_coverage-0.1.0-py3-none-any.whl Python 3 none any Details for crimson_nbval_coverage-0.1.0-py3-none-any.whl

Total release size: 11.8 kB

Release files / crimson_nbval_coverage-0.1.0.tar.gz

Download URL crimson_nbval_coverage-0.1.0.tar.gz
Size 5.8 kB
Tags Source
SHA-256 checksum
How to use checksums
7c5267d93d0f1b1368544ab8c205fcba25d904ea07f839bcdff7532416c5f59a
BLAKE2b-256 checksum
How to use checksums
21ec53fde916c20ceed25ba8dd22a4098537fb04406af0b44fa616671aef246d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.9.20

Release files / crimson_nbval_coverage-0.1.0-py3-none-any.whl

Download URL crimson_nbval_coverage-0.1.0-py3-none-any.whl
Size 6.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0d35991b6ba120255836dc9bc2f1f914d04b51f456ece43177c958827e9a0f81
BLAKE2b-256 checksum
How to use checksums
b9bac176c8e542d118f9cb6ca7934c049f1d0047509b06a051291d2b0ae5b6f0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.9.20

Security for crimson-nbval-coverage 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page