Skip to main content

A simple CLI tool.

Project description

Yellow Banana

Yellow Banana is as a template for creating PyPI packages.

In order to create your own package, replace all occurrences of the word "yellow_banana" in the codebase, and rename the yellow_banana folder, to whatever you want your package to be called.

Development

  1. Clone the repository:

    git clone https://github.com/bloominstituteoftechnology/yellow_banana.git
    cd yellow_banana
    
  2. Create and activate a virtual environment:

    python -m venv venv
    source venv/bin/activate  # On Windows use `venv\Scripts\activate`
    
  3. Install dependencies

    pip install -r requirements.txt
    
  4. Build and install the package:

    python setup.py sdist bdist_wheel
    pip install dist/yellow_banana-0.1.0-py3-none-any.whl
    
  5. Run the package:

    export OPENAI_API_KEY="xyz"
    yellow_banana "What is the meaning of life?"
    

Publishing

  1. Make an account at Pypi and set up their token in your environment.

  2. Install Twine:

    pip install twine
    
  3. Build the app:

    python setup.py sdist bdist_wheel
    
  4. Upload to PyPI:

    twine upload dist/*
    

Usage of the package

Install the package using pip:

pip install yellow_banana

Set your environment variable:

export OPENAI_API_KEY ="some_value"

Use the tool:

yellow_banana "What is the meaning of life?"

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

yellow_banana-0.1.1.tar.gz (3.1 kB view details)

Uploaded Source

Built Distribution

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

yellow_banana-0.1.1-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yellow_banana-0.1.1.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.12

File hashes

Hashes for yellow_banana-0.1.1.tar.gz
Algorithm Hash digest
SHA256 580c8b4d75b16e0c736921c2eb3d9c692fa8b2dff094eaf87651f7cfea22c404
MD5 26e9711ef86825a63f5d48618b3b1632
BLAKE2b-256 663807c4f162c3d49d7987d20353ffbc3a58f98ba21408692c96288a12a79ab6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: yellow_banana-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 3.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.12

File hashes

Hashes for yellow_banana-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3f033af32cc3970e43a07db74a1285965827f840f1b322b67777660b21c7e56f
MD5 94c170792d476c386735a2c939e8b9c3
BLAKE2b-256 b798e1c0e9190cd72432c4124bbdfd83f321d2bb205970e46382fef3bc40c1f0

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