https://github.com/dternyak/molten-boilerplate

A boilerplate for the molten framework by Bogdanp https://github.com/Bogdanp/molten
https://github.com/dternyak/molten-boilerplate

api-documentation api-rest backend molten openapi python python3 restful-api swagger

Last synced: about 2 months ago
JSON representation

A boilerplate for the molten framework by Bogdanp https://github.com/Bogdanp/molten

• Host: GitHub
• URL: https://github.com/dternyak/molten-boilerplate
• Owner: dternyak
• Created: 2018-09-29T18:57:43.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2018-09-30T19:09:28.000Z (almost 6 years ago)
• Last Synced: 2024-07-23T07:44:52.203Z (2 months ago)
• Topics: api-documentation, api-rest, backend, molten, openapi, python, python3, restful-api, swagger
• Language: Python
• Homepage:
• Size: 51.8 KB
• Stars: 49
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Molten-Boilerplate

## What's included?

- SQLAlchemy

- alembic

- camelCase API

- py.test (with coverage)

- invoke (CLI)

## Usage

1. Install requirements

```

virtualenv -p python3.6 venv

source venv/bin/activate

pip install -r requirements.txt

```

2. Adjust `settings.toml` with your `DATABASE_URL` on `common` and `test`.

For now, `common` represents both production and dev.

Finally, run:

```

alembic upgrade head

```

If you make changes to your model,

you'll need to adjust `migrations/env` to import any new models.

Then, run:

```

alembic revision -m "New thing did" --autogenerate

```

### Dev

```

$ invoke start

```

### Test

```

$ invoke test --cov --verbose

```

## TODO

- [ ] Integrate pre-commit linting