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_github_app-0.1.0.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

crimson_github_app-0.1.0-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file crimson_github_app-0.1.0.tar.gz.

File metadata

  • Download URL: crimson_github_app-0.1.0.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for crimson_github_app-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d6dcf674f58739031540a235369ae750372c36f958f547f924df34cf35cd6b46
MD5 6a622cc541282beb74114b22a5cedb85
BLAKE2b-256 7df80149ca0ace088e15c12e3911fce15c263346a8f68820dd1acdd248ddbad8

See more details on using hashes here.

File details

Details for the file crimson_github_app-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for crimson_github_app-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 702d9ff82c6470558903db836cb9c8350c3ab607aac8f1e266bd4d408d53d5d6
MD5 ea07998ad9ef07a2bb75d99ccefeea43
BLAKE2b-256 83d2a9f06bf8ede37e6bd2efcf6621273454bc89603c8fafed09efadd1004f11

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