https://github.com/preocts/githubclient
Submit text files to a target repo as a pull request on new branch
https://github.com/preocts/githubclient
Last synced: about 1 year ago
JSON representation
Submit text files to a target repo as a pull request on new branch
- Host: GitHub
- URL: https://github.com/preocts/githubclient
- Owner: Preocts
- License: mit
- Created: 2021-03-28T05:12:50.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-05-05T15:37:45.000Z (about 2 years ago)
- Last Synced: 2025-03-16T23:46:14.153Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 188 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.python.org/downloads)
[](https://github.com/psf/black)
[](https://github.com/pre-commit/pre-commit)
[](https://results.pre-commit.ci/latest/github/Preocts/githubclient/main)
[](https://github.com/Preocts/githubclient/actions/workflows/python-tests.yml)
# githubclient
Submit text files to a target repo as a pull request on new branch
---
## What is this project?
[Read the write-up here](docs/write-up.md)
---
# Local developer installation
The following steps outline how to install this repo for local development. See
the [CONTRIBUTING.md](CONTRIBUTING.md) file in the repo root for information on
contributing to the repo.
## Prerequisites
### Clone repo
```console
git clone https://github.com/Preocts/githubclient
cd githubclient
```
### Virtual Environment
Use a ([`venv`](https://docs.python.org/3/library/venv.html)), or equivalent,
when working with python projects. Leveraging a `venv` will ensure the installed
dependency files will not impact other python projects or any system
dependencies.
**Windows users**: Depending on your python install you will use `py` in place
of `python` to create the `venv`.
**Linux/Mac users**: Replace `python`, if needed, with the appropriate call to
the desired version while creating the `venv`. (e.g. `python3` or `python3.8`)
**All users**: Once inside an active `venv` all systems should allow the use of
`python` for command line instructions. This will ensure you are using the
`venv`'s python and not the system level python.
### Create the `venv`:
```console
python -m venv venv
```
Activate the `venv`:
```console
# Linux/Mac
. venv/bin/activate
# Windows
venv\Scripts\activate
```
The command prompt should now have a `(venv)` prefix on it. `python` will now
call the version of the interpreter used to create the `venv`
To deactivate (exit) the `venv`:
```console
deactivate
```
---
## Developer Installation Steps
### Install editable library and development requirements
```console
python -m pip install --editable .[dev,test]
```
### Install pre-commit [(see below for details)](#pre-commit)
```console
pre-commit install
```
### Install with nox
If you have `nox` installed with `pipx` or in the current venv you can use the
following session. This is an alternative to the two steps above.
```console
nox -s install
```
---
## Pre-commit and nox tools
### Run pre-commit on all files
```console
pre-commit run --all-files
```
### Run tests with coverage (quick)
```console
nox -e coverage
```
### Run tests (slow)
```console
nox
```
### Build dist
```console
nox -e build
```
---
## Updating dependencies
New dependencys can be added to the `requirements-*.in` file. It is recommended
to only use pins when specific versions or upgrades beyond a certain version are
to be avoided. Otherwise, allow `pip-compile` to manage the pins in the
generated `requirements-*.txt` files.
Once updated following the steps below, the package can be installed if needed.
### Update the generated files with changes
```console
nox -e update
```
### Upgrade all generated dependencies
```console
nox -e upgrade
```
---
## [pre-commit](https://pre-commit.com)
> A framework for managing and maintaining multi-language pre-commit hooks.
This repo is setup with a `.pre-commit-config.yaml` with the expectation that
any code submitted for review already passes all selected pre-commit checks.
---
## Error: File "setup.py" not found
Update `pip` to at least version 22.3.1