Metadata-Version: 2.1
Name: open-dev
Version: 0.1.7
Summary: A collection of tooling to enable open source development..
Home-page: https://github.com/8ball030/open_dev
License: Apache-2.0
Author: 8Baller
Author-email: 8ball030@gmail.com
Requires-Python: >=3.7.2,<4.0
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: dev
Provides-Extra: doc
Provides-Extra: test
Requires-Dist: GitPython (>=3.1.27,<4.0.0)
Requires-Dist: black (>=22.6.0,<23.0.0) ; extra == "test"
Requires-Dist: bump2version (>=1.0.1,<2.0.0) ; extra == "dev"
Requires-Dist: click (==8.0.2)
Requires-Dist: isort (>=5.10.1,<6.0.0) ; extra == "test"
Requires-Dist: mkdocs (>=1.3.1,<2.0.0) ; extra == "doc"
Requires-Dist: mkdocs-autorefs (>=0.4.1,<0.5.0) ; extra == "doc"
Requires-Dist: mkdocs-include-markdown-plugin (>=3.6.1,<4.0.0) ; extra == "doc"
Requires-Dist: mkdocs-material (>=8.4.0,<9.0.0) ; extra == "doc"
Requires-Dist: mkdocs-material-extensions (>=1.0.3,<2.0.0)
Requires-Dist: mkdocstrings (>=0.19.0,<0.20.0) ; extra == "doc"
Requires-Dist: mypy (>=0.971,<0.972) ; extra == "test"
Requires-Dist: openai (>=0.27.0,<0.28.0)
Requires-Dist: pip (>=22.2.2,<23.0.0) ; extra == "dev"
Requires-Dist: pre-commit (>=2.20.0,<3.0.0) ; extra == "dev"
Requires-Dist: pylama[all] (>=8.4.1,<9.0.0) ; extra == "test"
Requires-Dist: pytest-cov (>=3.0.0,<4.0.0) ; extra == "test"
Requires-Dist: rich-click (>=1.5.2,<2.0.0)
Requires-Dist: toml (>=0.10.2,<0.11.0) ; extra == "dev"
Requires-Dist: tox (>=3.25.1,<4.0.0) ; extra == "dev"
Requires-Dist: twine (>=4.0.1,<5.0.0) ; extra == "dev"
Requires-Dist: yamllint (>=1.27.1,<2.0.0)
Description-Content-Type: text/markdown

# Open_Dev

open_dev is a command-line tool built to assist developers in creating pull requests with ease. The tool interacts with the OpenAI GPT-3 API to generate a summary of changes made to a repository and use it to create a pull request.

## Requirements
[![pypi](https://img.shields.io/pypi/v/open_dev.svg)](https://pypi.org/project/open_dev/)
[![python](https://img.shields.io/pypi/pyversions/open_dev.svg)](https://pypi.org/project/open_dev/)
[![Build Status](https://github.com/8ball030/open_dev/actions/workflows/dev.yml/badge.svg)](https://github.com/8ball030/open_dev/actions/workflows/dev.yml)
[![codecov](https://codecov.io/gh/8ball030/open_dev/branch/main/graphs/badge.svg)](https://codecov.io/github/8ball030/open_dev)

## Installation from Source
To install open_dev, you must have Python 3.6 or later installed on your system.

Clone this repository: `git clone https://github.com/8ball030/open_dev.git.`
Navigate to the project directory: `cd open_dev`.
Install the required dependencies: `pip install -r requirements.txt`.
Set up your OPENAI_API_KEY environment variable by following the instructions here.
Run `python setup.py install` to install open_dev.

## Install from Pip
You can also install open_dev from pip by running the following command:

```bash
pip install open_dev
```


## Usage
Once open_dev is installed, you can use it by running the open-dev command in your terminal.

```bash
odev repo pull --help

 Usage: odev repo pull [OPTIONS]

 Creates a pull request based on a summary of changes from chatgpt.

╭─ Options ───────────────────────────────────────────────────────────────────╮
│ --target-branch  -tb  TEXT  The target branch to compare against.           │
│ --title          -t   TEXT  The title of the PR. If none will be            │
│                             autogenerated by chatgpt3.                      │
│ --description    -d   TEXT  The description of the PR. If none will be      │
│                             autogenerated by chatgpt3.                      │
│ --dry-run                   Simulate the commit and pr creation.            │
│ --help                      Show this message and exit.                     │
╰─────────────────────────────────────────────────────────────────────────────╯

 ```

```bash
open-dev repo pull
```
You can also specify options when running the pull command. For example, to specify a target branch, you can run:


```bash
open-dev repo pull --target-branch develop
```
License
This project is licensed under the MIT License.

