Skip to main content

Insert project description here

Project description

# GitItPyTest

This repository in used by the Git-It utility. The push test must connect to anonline

## Dependencies

  • Python 3.10

  • FastAPI

  • uvicorn

  • Docker

## Running Locally

There are two approaches to running the API locally.

Run the API directly

` > python3.10 -m venv .venv > source .venv/bin/activate > pip install --upgrade pip > pip install -r requirements.txt > ./run.sh `

Run the API via Docker Compose

Make sure the environment variables are set in the current environment.

`bash export PROJECT_ID=$(gcloud config get-value project) export GCP_KEY_PATH=[path to the service account credential file] ` Project Short Description (default ini)

Project long description or extended summary goes in here (default ini)

Testing

This project uses pytest to run tests and also to test docstring examples.

Install the test dependencies.

$ pip install -r requirements_test.txt

Run the tests.

Developing

This project uses black to format code and flake8 for linting. We also support pre-commit to ensure these have been run. To configure your local environment please install these development dependencies and set up the commit hooks.

$ pip install black flake8 pre-commit
$ pre-commit install

Releasing

Releases are published automatically when a tag is pushed to GitHub.

# Set next version number
export RELEASE = x.x.x

# Create tags
git commit --allow -empty -m "Release $RELEASE"
git tag -a $RELEASE -m "Version $RELEASE"

# Push
git push upstream --tags

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

git-it-0.0.16.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

git_it-0.0.16-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file git-it-0.0.16.tar.gz.

File metadata

  • Download URL: git-it-0.0.16.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for git-it-0.0.16.tar.gz
Algorithm Hash digest
SHA256 358e6eb5258fa0d2db6abc9d449f312de5474028e288e41b47df09303e2bdef0
MD5 cecc38ba355cb583e4072ea3903f6a3b
BLAKE2b-256 6018133e60cad89b7d646120050ee988d225c363d481b67c0dd0d82cc0b8c029

See more details on using hashes here.

File details

Details for the file git_it-0.0.16-py3-none-any.whl.

File metadata

  • Download URL: git_it-0.0.16-py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for git_it-0.0.16-py3-none-any.whl
Algorithm Hash digest
SHA256 a05ef6ca92c6ffa84eb1292fac4c8e9854ac3a13b6a57c896ae3662b7735f0fc
MD5 445f1a580f4eac53f6db04952a000df2
BLAKE2b-256 68d7e6d460597b95ed8e2ce660082f8dbbdc4c61a6c4bc5710aeaf0ed5b17fe8

See more details on using hashes here.

Supported by

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