Skip to main content

Your package description.

Project description

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,

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

crimson_anytree_extension-0.1.1.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file crimson_anytree_extension-0.1.1.tar.gz.

File metadata

File hashes

Hashes for crimson_anytree_extension-0.1.1.tar.gz
Algorithm Hash digest
SHA256 0f8cc68fa2547f9321ed111b0495c2349aed0fe4ca00db9bd09d2f03046a815c
MD5 fe938eabb245e87923bcbc38469a8ab4
BLAKE2b-256 2aa059a57b1488cac9af9ae0a7c1a22eef8e810c705f6761b2a0388d5815b275

See more details on using hashes here.

File details

Details for the file crimson_anytree_extension-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for crimson_anytree_extension-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 16e284ae692880283f5b472d8adb4a5777a920265d6e2a8bd1767d4abeff24f9
MD5 9eb34fbd4dfd7e3b0f4d531fee85a390
BLAKE2b-256 9b38eb02257ac2f178ef7be8d81fac28d4c766744deffc34f7347bfd364453fe

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