Skip to content

Commit 5779c39

Browse files
committed
Initial commit
0 parents  commit 5779c39

File tree

16 files changed

+585
-0
lines changed

16 files changed

+585
-0
lines changed

.github/workflows/ci.yml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: "CI"
2+
3+
on:
4+
pull_request: {}
5+
push:
6+
branches:
7+
- "master"
8+
9+
jobs:
10+
test:
11+
runs-on: "ubuntu-latest"
12+
13+
steps:
14+
- uses: "actions/checkout@v2"
15+
16+
- name: "Set up Python 3.8"
17+
uses: "actions/setup-python@v1"
18+
with:
19+
python-version: "3.8"
20+
21+
- name: "Lint extension"
22+
run: |
23+
pip3 install flake8
24+
flake8 .
25+
26+
- name: "Install dependencies and local package"
27+
run: |
28+
pip3 install Flask==1.1.2
29+
make install
30+
31+
- name: "Ensure databases are created and seeded"
32+
run: |
33+
cd tests/example_app
34+
35+
flask db reset --with-testdb > default_results
36+
stat exampledb
37+
stat exampledb_test
38+
[ -s default_results ]
39+
env:
40+
FLASK_APP: "example.app"

.gitignore

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Created by https://www.gitignore.io/api/python,osx
2+
3+
### OSX ###
4+
*.DS_Store
5+
.AppleDouble
6+
.LSOverride
7+
8+
# Icon must end with two \r
9+
Icon
10+
11+
# Thumbnails
12+
._*
13+
14+
# Files that might appear in the root of a volume
15+
.DocumentRevisions-V100
16+
.fseventsd
17+
.Spotlight-V100
18+
.TemporaryItems
19+
.Trashes
20+
.VolumeIcon.icns
21+
.com.apple.timemachine.donotpresent
22+
23+
# Directories potentially created on remote AFP share
24+
.AppleDB
25+
.AppleDesktop
26+
Network Trash Folder
27+
Temporary Items
28+
.apdisk
29+
30+
### Python ###
31+
# Byte-compiled / optimized / DLL files
32+
__pycache__/
33+
*.py[cod]
34+
*$py.class
35+
36+
# C extensions
37+
*.so
38+
39+
# Distribution / packaging
40+
.Python
41+
build/
42+
develop-eggs/
43+
dist/
44+
downloads/
45+
eggs/
46+
.eggs/
47+
lib/
48+
lib64/
49+
parts/
50+
sdist/
51+
var/
52+
wheels/
53+
*.egg-info/
54+
.installed.cfg
55+
*.egg
56+
57+
# PyInstaller
58+
# Usually these files are written by a python script from a template
59+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
60+
*.manifest
61+
*.spec
62+
63+
# Installer logs
64+
pip-log.txt
65+
pip-delete-this-directory.txt
66+
67+
# Unit test / coverage reports
68+
htmlcov/
69+
.tox/
70+
.coverage
71+
.coverage.*
72+
.cache
73+
.pytest_cache/
74+
nosetests.xml
75+
coverage.xml
76+
*.cover
77+
.hypothesis/
78+
79+
# Translations
80+
*.mo
81+
*.pot
82+
83+
# End of https://www.gitignore.io/api/python,osx
84+
85+
tests/example_app/exampledb
86+
tests/example_app/exampledb_test
87+
tests/example_app/example/exampledb

CHANGELOG.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a
6+
Changelog](https://keepachangelog.com/en/1.0.0/).
7+
8+
## [Unreleased]
9+
10+
- Nothing yet!
11+
12+
## [0.1.0] - 2020-11-19
13+
14+
### Added
15+
16+
- Everything!
17+
18+
[Unreleased]: https://github.com/nickjj/flask-db/compare/0.1.0...HEAD
19+
[0.1.0]: https://github.com/nickjj/flask-db/releases/tag/0.1.0

LICENSE

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2020 Nick Janetakis
4+
5+
Permission is hereby granted, free of charge, to any person obtaining
6+
a copy of this software and associated documentation files (the
7+
'Software'), to deal in the Software without restriction, including
8+
without limitation the rights to use, copy, modify, merge, publish,
9+
distribute, sublicense, and/or sell copies of the Software, and to
10+
permit persons to whom the Software is furnished to do so, subject to
11+
the following conditions:
12+
13+
The above copyright notice and this permission notice shall be
14+
included in all copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
17+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Makefile

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.PHONY: help
2+
help:
3+
@printf "%s\n" "Useful targets:"
4+
@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m make %-20s\033[0m %s\n", $$1, $$2}'
5+
6+
.PHONY: install
7+
install: ## Install package to dev environment
8+
pip3 install --user --editable .
9+
10+
.PHONY: uninstall
11+
uninstall: ## Uninstall package from dev environment
12+
python3 setup.py develop --user -u
13+
14+
.PHONY: clean
15+
clean: ## Remove build related files
16+
python3 setup.py sdist clean --all
17+
rm -rf build/ dist/ *.egg-info/
18+
19+
.PHONY: build
20+
build: ## Build package and wheel
21+
python3 setup.py sdist bdist_wheel
22+
23+
.PHONY: publish
24+
publish: ## Publish package to PyPI
25+
python3 setup.py sdist upload

0 commit comments

Comments
 (0)