Metadata-Version: 2.1
Name: autonomous-app
Version: 0.3.0
Summary: Containerized application framework built on Flask with additional libraries and tools for rapid development of web applications.
Author-email: Steven A Moore <samoore@binghamton.edu>
License: MIT License
        
        Copyright (c) [2022] Steven Allen Moore
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: homepage, https://github.com/Sallenmoore/autonomous
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Flask
Requires-Dist: setuptools
Requires-Dist: python-dotenv
Requires-Dist: PyGithub
Requires-Dist: pygit2
Requires-Dist: mongoengine
Requires-Dist: pillow
Requires-Dist: redis
Requires-Dist: jsmin
Requires-Dist: requests
Requires-Dist: gunicorn
Requires-Dist: Authlib
Requires-Dist: rq
Requires-Dist: openai>=1.42
Requires-Dist: dateparser
Requires-Dist: python-slugify

# Autonomous

:warning: :warning: :warning: WiP :warning: :warning: :warning:

![Tests](https://github.com/Sallenmoore/autonomous/actions/workflows/tests.yml/badge.svg)

A local, containerized, service based application library built on top of Flask.
A self-contained containerized Python applications with minimal dependencies using built in libraries for many different kinds of tasks.

- **[pypi](https://test.pypi.org/project/autonomous)**
- **[github](https://github.com/Sallenmoore/autonomous)**

## Features

- Fully containerized, service based Python application framework
- All services are localized to a virtual intranet
- Container based MongoDB database
- Model ORM API
- File storage locally or with services such as Cloudinary or S3 
- Separate service for long running tasks
- Built-in Authentication with Google or Github
- Auto-Generated Documentation Pages

## Dependencies

- **Languages**
  - [Python 3.11](/Dev/language/python)
- **Frameworks**
  - [Flask](https://flask.palletsprojects.com/en/2.1.x/)
- **Containers**
  - [Docker](https://docs.docker.com/)
  - [Docker Compose](https://github.com/compose-spec/compose-spec/blob/master/spec.md)
- **Server**
  - [nginx](https://docs.nginx.com/nginx/)
  - [gunicorn](https://docs.gunicorn.org/en/stable/configure.html)
- **Networking and Serialization**
  - [requests](https://requests.readthedocs.io/en/latest/)
- **Database**
  - [pymongo](https://pymongo.readthedocs.io/en/stable/api/pymongo/index.html)
- **Testing**
  - [pytest](/Dev/tools/pytest)
  - [coverage](https://coverage.readthedocs.io/en/6.4.1/cmd.html)
- **Documentation** - Coming Soon
  - [pdoc](https://pdoc.dev/docs/pdoc/doc.html)
---

## Developer Notes

### TODO

- Setup/fix template app generator
- Add type hints
- Switch to less verbose html preprocessor
- 100% testing coverage

### Issue Tracking

- None

## Processes

### Generate app

TDB

### Tests

```sh
make tests
```

### package

1. Update version in `/src/autonomous/__init__.py`
2. `make package`
