semvec/pypi-packages huggingface dataset:
mongodatabaseconnnect 0.0.1
A Python package to connect to MongoDB
License: MIT
Requires Python: >=3.7


# requirements_dev.txt we use for the testing
It makes it easier to install and manage dependencies for development and testing, separate from the dependencies required for production.

# difference between requirements_dev.txt and requirements.txt

requirements.txt is used to specify the dependencies required to run the production code of a Python project, while requirements_dev.txt is used to specify the dependencies required for development and testing purposes.

# tox.ini
We use if for the testing in the python package testing against different version of the python 

## how tox works tox enviornment creation
1. Install depedencies and packages 
2. Run commands
3. Its a combination of the (virtualenvwrapper and makefile)
4. It creates a .tox


# pyproject.toml
it is being used for configuration the python project it is a alternative of the setup.cfg file. its containts configuration related to the build system
such as the build tool used package name version author license and dependencies

# setup.cfg
In summary, setup.cfg is used by setuptools to configure the packaging and installation of a Python projec

# Testing python application
*types of testing*
1. Automated testing 
2. Manual testing

*Mode of testing*
1. Unit testing
2. Integration tests

*Testing frameworks*

1. pytest
2. unittest
3. robotframework
4. selenium
5. behave
6. doctest

# check with the code style formatting and syntax(coding standard)

1. pylint
2. flake8(it is best because it containt 3 library pylint pycodestyle mccabe)
3. pycodestyle
zed-assistant 0.0.4
Zed is an LLM-based CLI assistant built with python and Chat GPT
License: MIT
Requires Python: <4.0,>=3.8


# Overview 
A helpful command line assistant, based on ChatGPT.

## Getting started
Install Zed by running: 
```bash
pip install zed-assistant
```
Note that Zed requires Python 3.8+.

You'll need your own OpenAI key to be able to use Zed. See "Configure" below to know how.

## Usage
Run `zed` with no arguments to get the help menu:
```
~ zed
     ______ ___________
    |___  /|  ___|  _  \
       / / | |__ | | | |
      / /  |  __|| | | |
    ./ /___| |___| |/ /
    \_____/\____/|___/  v0.0.4

usage: zed [-h] [--version] [--debug] [--model {gpt-4o,gpt-4-turbo,gpt-3.5-turbo}] [--yoda-mode]

zed is a LLM-based CLI assistant.

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --debug               Enables print debug logs.
  --model {gpt-4o,gpt-4-turbo,gpt-3.5-turbo}
                        The specific Open AI model to be used. Default is 'gpt-4o'
  --yoda-mode           Enables Master Yoda mode.
```

## Configure
After you run `zed` for the first time, a default configuration file is created. To include your Open AI key, or 
change other settings, edit the `~/.zed/config` file:
```bash
openai_key=<YOUR_OPEN_AI_KEY>
model=gpt-4-turbo
debug=False
yoda_mode=False
```



# Contributing 
## Install dependencies
Setup the project locally:
```bash
git clone https://github.com/hoffmannmatheus/zed/ && cd zed
poetry install
```

## Run tests
```bash
poetry run pytest
```

## Run zed locally
First, setup your local OpenAI API in the `~/.zed/config` file. 
Then, run locally with:
```bash
poetry run zed
```

## Publishing a new version
```bash
poetry publish --build
```