Skip to main content

No project description provided

Project description

Instructions

Setup instructions

  1. Clone this repo and go to this project
git clone https://github.com/xKarinSan/Code2Docs.git
cd Code2Docs
  1. Go to code2docs_cli
cd code2docs-cli
  1. Install all the dependencies
pip install -r requirements.txt
  1. Run the app
cd code2docs_cli
python main.py

Building instructions

  1. Install poetry (More info on poetry poetry). pipx is required (More info on pipx here)
pipx install poetry
  1. Clone this repo and go to this project
git clone https://github.com/xKarinSan/Code2Docs.git
cd Code2Docs
  1. Go to code2docs_cli
cd code2docs_cli
  1. Install the project using poetry
poetry install
  1. Open the poetry shell
poetry shell
  1. Run the CLI
code2docs-cli

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

code2docs_cli-0.1.0.tar.gz (1.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

code2docs_cli-0.1.0-py3-none-any.whl (2.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: code2docs_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 1.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.9 Darwin/21.6.0

File hashes

Hashes for code2docs_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b02293c32db2c293d6c6000833243f2b4806bcefd3b72f970e4ef20dcd3068ee
MD5 3e005a019bfc58648ed398dd1033641d
BLAKE2b-256 ebb661f15af565013a93ad915b7ef15d18714a5fc4ee29dfe28a2d9b54273014

See more details on using hashes here.

File details

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

File metadata

  • Download URL: code2docs_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 2.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.9 Darwin/21.6.0

File hashes

Hashes for code2docs_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e52e8f141d39d1e4085efc11a6583fa50cd597169ea0926d13e89fa428a7dd75
MD5 87a3883b57803c632f414883f2f3aba9
BLAKE2b-256 5d3df14c202d6ceb8254f63b948cd518227f5d9512384e47ac1728b6a46c2e12

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page