overholt - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #ai #typescript #llm #android #deep-learning #docker #nodejs #windows #awesome-list #security #pytorch #ios

overholt

(★ 1,595)

Example Flask application illustrating some of my common practices

File Explorer

Download Latest Version (.zip)

- - 4fe474604dbb_add_stores_managers_.py
  - 5a0e003fafb2_first_revision.py
- env.py
- README
- script.py.mako
- - .gitignore
- - .gitignore
- api.rst
- architecture.rst
- conf.py
- index.rst
- make.bat
- Makefile
- - __init__.py
  - products.py
  - stores.py
  - users.py
- - __init__.py
  - assets.py
  - dashboard.py
- - __init__.py
  - products.py
  - stores.py
  - users.py
- - __init__.py
  - forms.py
  - models.py
- - __init__.py
  - forms.py
  - models.py
- - __init__.py
  - forms.py
  - models.py
- __init__.py
- core.py
- factory.py
- forms.py
- helpers.py
- middleware.py
- models.py
- services.py
- settings.py
- tasks.py
- - __init__.py
  - product_tests.py
  - store_tests.py
  - user_tests.py
- - __init__.py
  - dashboard_tests.py
- __init__.py
- factories.py
- settings.py
- utils.py
.gitignore
alembic.ini
Berksfile
Dockerfile
LICENSE
manage.py
README.md
requirements.txt
Vagrantfile
wercker.yml
wsgi.py

# Installation Guide

1. Get the code

git clone https://github.com/mattupstate/overholt

Downloads the entire project code from GitHub to your computer.

cd overholt

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker build -t overholt .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 overholt

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

$ pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Overholt

Overholt is an example Flask application illustrating some of my common practices

## Development Environment

At the bare minimum you'll need the following for your development environment:

1. [Python](http://www.python.org/)
2. [MySQL](http://www.mysql.com/)
3. [Redis](http://redis.io/)

It is strongly recommended to also install and use the following tools:

1. [virtualenv](https://python-guide.readthedocs.org/en/latest/dev/virtualenvs/#virtualenv)
2. [virtualenvwrapper](https://python-guide.readthedocs.org/en/latest/dev/virtualenvs/#virtualenvwrapper)
3. [Vagrant](http://vagrantup.com)
3. [Berkshelf](http://berkshelf.com)

### Local Setup

The following assumes you have all of the recommended tools listed above installed.

#### 1. Clone the project:

$ git clone git@github.com:mattupstate/overholt.git
    $ cd overholt

#### 2. Create and initialize virtualenv for the project:

$ mkvirtualenv overholt
    $ pip install -r requirements.txt

#### 3. Install the required cookbooks:

$ berks install

#### 4. Install the Berkshelf plugin for Vagrant:

$ vagrant plugin install vagrant-berkshelf

#### 5. Start virtual machine:

$ vagrant up

#### 6. Upgrade the database:

$ alembic upgrade head

#### 7. Run the development server:

$ python wsgi.py

#### 8. In another console run the Celery app:

$ celery -A overholt.tasks worker

#### 9. Open [http://localhost:5000](http://localhost:5000)

### Development

If all went well in the setup above you will be ready to start hacking away on
the application.

#### Database Migrations

This application uses [Alembic](http://alembic.readthedocs.org/) for database
migrations and schema management. Changes or additions to the application data
models will require the database be updated with the new tables and fields.
Additionally, ensure that any new models are imported into the consolidated
models file at `overholt.models`. To generate a migration file based on the
current set of models run the following command:

$ alembic revision --autogenerate -m "<a description of what was modified>"

Review the resulting version file located in the `alembic/versions` folder. If
the file is to your liking upgrade the database with the following command:

$ alembic upgrade head

For anything beyond this workflow please read the Alembic documentation.

#### Management Commands

Management commands can be listed with the following command:

$ python manage.py

These can sometimes be useful to manipulate data while debugging in the browser.

#### Tests

To run the tests use the following command:

$ nosetests