Skip to main content

Installation

uv add koushin

Implementation

1) Creating config

koushin generate

1.1) Adding informations

after entering koushin generate developer will be asked with few prompts (make sure .venv is active).

  1. project name (it should be same as repo name) :
  2. github repo url for the project :
  3. project path where it will be installed at client side :

after this config.koushin will be generated ! with the following :

[github]
repo = your project repo url
[project]
name = your project name
[version]
version-manager = your project repo url/refs/heads/main/config.koushin
version = 0.0.1
[path]
install-path = client installation path

2) Implementing updater

NOTE : as a developer you would have to create a seperate updater file where koushin will do its work. the logic should be your to update as you desire .

For normal updater developer would only have to use two methods

from koushin.core.koushin import Updater

my_project = Updater()

if my_project.check_verison(): # <--- checks for update if there is then it will return true else false
    my_project.update() # <--- updates your project automatically

Thats it ! new method will be uploaded if i need to make one for now i will be implemnting koushin to my personal projects .

Docs for how i made it will be uploaded soon : )

Logging

koushin now includes built-in logging. Logs are stored in a LOG/ directory at the project root in LOG/koushin.log. The logger is automatically initialized when koushin is imported.

CLI Commands

koushin generate    # Generate config.koushin
koushin info        # Show info

Utility Functions

  • generate_clean_path(path, project_name) — strips the project name from a full path to return the parent directory
  • add_install_path(path) — updates the install-path in config.koushin
  • get_config() — fetches the cloud (GitHub) config.koushin and returns metadata
  • cretate_logger_file() — creates the LOG/ directory and returns its path

Metadata

Release files for koushin 1.2.7

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

Source distribution (sdist)

Source distribution for koushin 1.2.7
File Size Uploaded Provenance
koushin-1.2.7.tar.gz 7.0 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for koushin 1.2.7
File Interpreter ABI Platform
koushin-1.2.7-py3-none-any.whl Python 3 none any Details

Total release size: 14.6 kB

Release files / koushin-1.2.7.tar.gz

Download URL koushin-1.2.7.tar.gz
Size 7.0 kB
Tags Source
SHA-256 checksum
How to use checksums
5c8a6ae73bcb6e83c4f831fa7f49351acc93ab6bee07546954037428bbfca932
BLAKE2b-256 checksum
How to use checksums
96a80e519688f47eaa42a20a220d7293eb2ce621b704104bd84698602f507d21
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Omarchy","version":"4.0.0","id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / koushin-1.2.7-py3-none-any.whl

Download URL koushin-1.2.7-py3-none-any.whl
Size 7.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c5668c81bf60f669c8b25f4f53646aed2a112c32b25619ded971f56ab965efbf
BLAKE2b-256 checksum
How to use checksums
2948a117b7eba1d852505a0c6ab46344eaecf7a7c70b9f01e5b9882995b32c0c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Omarchy","version":"4.0.0","id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for koushin 1.2.7

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.

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