Metadata-Version: 2.4
Name: grants-shared
Version: 0.2.6
Summary: Shared code used by the Simpler Grants.gov repo
Author-email: Nava Engineering <engineering@navapbc.com>
License-Expression: CC0-1.0
Project-URL: Homepage, https://github.com/HHS/simpler-grants-gov
Project-URL: Issues, https://github.com/HHS/simpler-grants-gov/issues
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.14
Requires-Python: <3.15,>=3.14
Description-Content-Type: text/markdown
Requires-Dist: apiflask<4,>=3.1.0
Requires-Dist: marshmallow<4,>=3.20.1
Requires-Dist: pydantic<3,>=2.13.3
Requires-Dist: pydantic-settings<3,>=2.14.0
Requires-Dist: sqlalchemy[mypy]<3,>=2.0.49
Requires-Dist: psycopg[binary]<4,>=3.3.4
Requires-Dist: botocore<2,>=1.43.3
Requires-Dist: boto3<2,>=1.43.3
Requires-Dist: smart-open<8,>=7.6.0
Requires-Dist: pytz<2027,>=2026.2
Requires-Dist: pyjwt[crypto]<3,>=2.12.1
Requires-Dist: jsonschema[format-nongpl]<5,>=4.26.0
Requires-Dist: jsonpath-ng<2,>=1.8.0
Requires-Dist: jsonref<2,>=1.1.0
Requires-Dist: pandas<3,>=2.0.3
Requires-Dist: pandas-stubs<3,>=2.0.3
Requires-Dist: newrelic<13,>=12.1.0
Requires-Dist: python-dotenv<2,>=1.2.2
Requires-Dist: beautifulsoup4<5,>=4.14.3

# Grants Shared

This repo contains the shared code used by the different backend APIs
on the simpler.grants.gov system.

This code is not meant to be used outside of the [Simpler Grants](https://github.com/HHS/simpler-grants-gov) system. 
We cannot provide support for anyone who attempts to use this code for other projects.

[License](https://github.com/HHS/simpler-grants-gov/blob/main/LICENSE.md)

## Installation
You can install this package with any python dependency manager.

```shell
# Using pip
pip install grants_shared

# Using poetry
poetry add grants_shared

# Using uv
uv add grants_shared
```

## Release Process

### Version Upgrade

When you make changes, upgrade the version of the package.

```shell
# Upgrade the version with uv
# https://docs.astral.sh/uv/guides/package/#updating-your-version

# Generally do a patch version (eg. 1.0.1 -> 1.0.2)
uv version --bump patch

# Or do a minor version for anything fairly big (eg. 1.1.3 -> 1.2.0)
# uv version --bump minor
```

### Release to PyPi
After your change has been merged to main, you can
publish a new release in PyPi with our [Github action](https://github.com/HHS/simpler-grants-gov/actions/workflows/publish-grants-shared.yml)


## Usage
Guidance on common commands and running the application will come in later
versions as we're still getting this setup, but a few basic commands to get you started.

```shell
# Build the docker image
make build

# Run tests
make test

# Formatting and linting
make format
make lint
```

Further documentation can be found in our [Github](https://github.com/HHS/simpler-grants-gov/tree/main/documentation)

