Skip to content

Commit bc48256

Browse files
timothycrosleytimothycrosley
committed
Initial commit
0 parents  commit bc48256

19 files changed

+552
-0
lines changed

‎.gitignore

+88
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
*.py[cod]
2+
.DS_Store
3+
# C extensions
4+
*.so
5+
6+
# Packages
7+
*.egg
8+
*.egg-info
9+
build
10+
eggs
11+
.eggs
12+
parts
13+
var
14+
sdist
15+
develop-eggs
16+
.installed.cfg
17+
lib
18+
lib64
19+
MANIFEST
20+
21+
# Installer logs
22+
pip-log.txt
23+
npm-debug.log
24+
pip-selfcheck.json
25+
26+
# Unit test / coverage reports
27+
.coverage
28+
.tox
29+
nosetests.xml
30+
htmlcov
31+
.cache
32+
.pytest_cache
33+
.mypy_cache
34+
35+
# Translations
36+
*.mo
37+
38+
# Mr Developer
39+
.mr.developer.cfg
40+
.project
41+
.pydevproject
42+
43+
# SQLite
44+
test_exp_framework
45+
46+
# npm
47+
node_modules/
48+
49+
# dolphin
50+
.directory
51+
libpeerconnection.log
52+
53+
# setuptools
54+
dist
55+
56+
# IDE Files
57+
atlassian-ide-plugin.xml
58+
.idea/
59+
*.swp
60+
*.kate-swp
61+
.ropeproject/
62+
63+
# Python3 Venv Files
64+
.venv/
65+
bin/
66+
include/
67+
lib/
68+
lib64
69+
pyvenv.cfg
70+
share/
71+
venv/
72+
.python-version
73+
74+
# Cython
75+
*.c
76+
77+
# Emacs backup
78+
*~
79+
80+
# VSCode
81+
/.vscode
82+
83+
# Automatically generated files
84+
docs/preconvert
85+
site/
86+
out
87+
poetry.lock
88+

‎LICENSE

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

‎cookiecutter.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"full_name": "Timothy Crosley",
3+
"email": "[email protected]",
4+
"github_username": "timothycrosley",
5+
"project_name": "python_project_name",
6+
"description": "Project short description.",
7+
"version": "0.0.1",
8+
}

‎{{cookiecutter.project_name}}/.coveragerc

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[report]
2+
exclude_lines =
3+
pragma: no cover
4+
omit =
5+
*tests*

‎{{cookiecutter.project_name}}/.gitignore

+88
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
*.py[cod]
2+
.DS_Store
3+
# C extensions
4+
*.so
5+
6+
# Packages
7+
*.egg
8+
*.egg-info
9+
build
10+
eggs
11+
.eggs
12+
parts
13+
var
14+
sdist
15+
develop-eggs
16+
.installed.cfg
17+
lib
18+
lib64
19+
MANIFEST
20+
21+
# Installer logs
22+
pip-log.txt
23+
npm-debug.log
24+
pip-selfcheck.json
25+
26+
# Unit test / coverage reports
27+
.coverage
28+
.tox
29+
nosetests.xml
30+
htmlcov
31+
.cache
32+
.pytest_cache
33+
.mypy_cache
34+
35+
# Translations
36+
*.mo
37+
38+
# Mr Developer
39+
.mr.developer.cfg
40+
.project
41+
.pydevproject
42+
43+
# SQLite
44+
test_exp_framework
45+
46+
# npm
47+
node_modules/
48+
49+
# dolphin
50+
.directory
51+
libpeerconnection.log
52+
53+
# setuptools
54+
dist
55+
56+
# IDE Files
57+
atlassian-ide-plugin.xml
58+
.idea/
59+
*.swp
60+
*.kate-swp
61+
.ropeproject/
62+
63+
# Python3 Venv Files
64+
.venv/
65+
bin/
66+
include/
67+
lib/
68+
lib64
69+
pyvenv.cfg
70+
share/
71+
venv/
72+
.python-version
73+
74+
# Cython
75+
*.c
76+
77+
# Emacs backup
78+
*~
79+
80+
# VSCode
81+
/.vscode
82+
83+
# Automatically generated files
84+
docs/preconvert
85+
site/
86+
out
87+
poetry.lock
88+

‎{{cookiecutter.project_name}}/.travis.yml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
dist: xenial
2+
language: python
3+
cache: pip
4+
install:
5+
- pip3 install poetry
6+
- poetry install
7+
matrix:
8+
include:
9+
- os: linux
10+
sudo: required
11+
python: 3.6
12+
- os: linux
13+
sudo: required
14+
python: 3.7
15+
env: DEPLOY=yes
16+
- os: osx
17+
language: generic
18+
script:
19+
- bash scripts/test.sh
20+
after_script:
21+
- bash <(curl -s https://codecov.io/bash)

‎{{cookiecutter.project_name}}/CHANGELOG.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Install the latest
2+
===================
3+
4+
To install the latest version of {{cookiecutter.project_name}} simply run:
5+
6+
`pip3 install {{cookiecutter.project_name}}`
7+
8+
OR
9+
10+
`poetry add {{cookiecutter.project_name}}`
11+
12+
OR
13+
14+
`pipenv install {{cookiecutter.project_name}}`
15+
16+
17+
Changelog
18+
=========
19+
## 1.0.0 - TBD
20+
- Initial API stable release.

‎{{cookiecutter.project_name}}/LICENSE

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

‎{{cookiecutter.project_name}}/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{{cookiecutter.project_name}}
2+
_________________
3+
4+
[![PyPI version](https://badge.fury.io/py/{{cookiecutter.project_name}}.svg)](http://badge.fury.io/py/{{cookiecutter.project_name}})
5+
[![Build Status](https://travis-ci.org/{{cookiecutter.github_username}}/{{cookiecutter.project_name}}.svg?branch=master)](https://travis-ci.org/{{cookiecutter.github_username}}/{{cookiecutter.project_name}})
6+
[![codecov](https://codecov.io/gh/{{cookiecutter.github_username}}/{{cookiecutter.project_name}}/branch/master/graph/badge.svg)](https://codecov.io/gh/{{cookiecutter.github_username}}/{{cookiecutter.project_name}})
7+
[![Join the chat at https://gitter.im/{{cookiecutter.github_username}}/{{cookiecutter.project_name}}](https://badges.gitter.im/{{cookiecutter.github_username}}/{{cookiecutter.project_name}}.svg)](https://gitter.im/{{cookiecutter.github_username}}/{{cookiecutter.project_name}}?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
8+
[![License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://pypi.python.org/pypi/{{cookiecutter.project_name}}/)
9+
[![Downloads](https://pepy.tech/badge/{{cookiecutter.project_name}})](https://pepy.tech/project/{{cookiecutter.project_name}})
10+
_________________
11+
12+
[Read Latest Documentation](https://{{cookiecutter.github_username}}.github.io/{{cookiecutter.project_name}}/) - [Browse GitHub Code Repository](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_name}}/)
13+
_________________
14+
15+
**{{cookiecutter.project_name}}** {{cookiecutter.description}}

‎{{cookiecutter.project_name}}/docs/contributing/1.-contributing-guide.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
Contributing to {{cookiecutter.project_name}}
2+
========
3+
4+
Looking for a useful open source project to contribute to?
5+
Want your contributions to be warmly welcomed and acknowledged?
6+
Welcome! You have found the right place.
7+
8+
## Getting {{cookiecutter.project_name}} set up for local development
9+
The first step when contributing to any project is getting it set up on your local machine. {{cookiecutter.project_name}} aims to make this as simple as possible.
10+
11+
Account Requirements:
12+
13+
- [A valid GitHub account](https://github.com/join)
14+
15+
Base System Requirements:
16+
17+
- Python3.6+
18+
- poetry
19+
- bash or a bash compatible shell (should be auto-installed on Linux / Mac)
20+
21+
Once you have verified that you system matches the base requirements you can start to get the project working by following these steps:
22+
23+
1. [Fork the project on GitHub](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_name}}/fork).
24+
2. Clone your fork to your local file system:
25+
`git clone https://github.com/$GITHUB_ACCOUNT/{{cookiecutter.project_name}}.git`
26+
3. `cd {{cookiecutter.project_name}}
27+
4. `poetry install`
28+
29+
## Making a contribution
30+
Congrats! You're now ready to make a contribution! Use the following as a guide to help you reach a successful pull-request:
31+
32+
1. Check the [issues page](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_name}}/issues) on GitHub to see if the task you want to complete is listed there.
33+
- If it's listed there, write a comment letting others know you are working on it.
34+
- If it's not listed in GitHub issues, go ahead and log a new issue. Then add a comment letting everyone know you have it under control.
35+
- If you're not sure if it's something that is good for the main {{cookiecutter.project_name}} project and want immediate feedback, you can discuss it [here](https://gitter.im/{{cookiecutter.github_username}}/{{cookiecutter.project_name}}).
36+
2. Create an issue branch for your local work `git checkout -b issue/$ISSUE-NUMBER`.
37+
3. Do your magic here.
38+
4. Ensure your code matches the [HOPE-8 Coding Standard](https://github.com/hugapi/HOPE/blob/master/all/HOPE-8--Style-Guide-for-Hug-Code.md#hope-8----style-guide-for-hug-code) used by the project.
39+
5. Submit a pull request to the main project repository via GitHub.
40+
41+
Thanks for the contribution! It will quickly get reviewed, and, once accepted, will result in your name being added to the acknowledgments list :).
42+
43+
## Thank you!
44+
I can not tell you how thankful I am for the hard work done by {{cookiecutter.project_name}} contributors like *you*.
45+
46+
Thank you!
47+
48+
~Timothy Crosley
49+

0 commit comments

Comments
 (0)