https://github.com/frankie567/aut

Authentication, simplified.
https://github.com/frankie567/aut

Last synced: 12 days ago
JSON representation

Authentication, simplified.

• Host: GitHub
• URL: https://github.com/frankie567/aut
• Owner: frankie567
• License: mit
• Created: 2025-08-23T11:27:54.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2025-08-23T12:23:47.000Z (about 2 months ago)
• Last Synced: 2025-10-02T07:29:34.715Z (18 days ago)
• Language: Python
• Size: 43.9 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# aut



    Authentication, simplified.



[![build](https://github.com/frankie567/aut/workflows/Build/badge.svg)](https://github.com/frankie567/aut/actions)

[![codecov](https://codecov.io/gh/frankie567/aut/branch/master/graph/badge.svg)](https://codecov.io/gh/frankie567/aut)

[![PyPI version](https://badge.fury.io/py/aut.svg)](https://badge.fury.io/py/aut)

---

**Documentation**: https://frankie567.github.io/aut/

**Source Code**: https://github.com/frankie567/aut

---

## Development

### Setup environment

We use [Hatch](https://hatch.pypa.io/latest/install/) to manage the development environment and production build. Ensure it's installed on your system.

### Run unit tests

You can run all the tests with:

```bash

hatch run test

```

### Format the code

Execute the following command to apply linting and check typing:

```bash

hatch run lint

```

### Publish a new version

You can bump the version, create a commit and associated tag with one command:

```bash

hatch version patch

```

```bash

hatch version minor

```

```bash

hatch version major

```

Your default Git text editor will open so you can add information about the release.

When you push the tag on GitHub, the workflow will automatically publish it on PyPi and a GitHub release will be created as draft.

## Serve the documentation

You can serve the Mkdocs documentation with:

```bash

hatch run docs-serve

```

It'll automatically watch for changes in your code.

## License

This project is licensed under the terms of the MIT license.