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

Uploaded Source

Built Distribution

crimson_faiss_indexer-0.1.0-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for crimson_faiss_indexer-0.1.0.tar.gz
Algorithm Hash digest
SHA256 49d3eb56f73246b15ba541cb5602787e164cb67a6c641a4b15c97e838950506a
MD5 60cfdc3e8df6ce9a77ab79366a55f889
BLAKE2b-256 9c5af5bc773234d372e2b46c46e4e1d5b98e782f511201c5d8450ebdb8ba728f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for crimson_faiss_indexer-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 37aac4da3e7f063c54fdac56589f42476e770017f75cdb0dfc737a654dfee9f8
MD5 17aa7256824330dab33a49e867da0676
BLAKE2b-256 e525a89afcfe9872c6a010034c5cb8ad96a89db7002bc857c9486cfdd1e35353

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