-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit abcda87
Showing
11 changed files
with
375 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
[flake8] | ||
max-line-length = 80 | ||
# Select (turn on) | ||
# * Complexity violations reported by mccabe (C) - | ||
# http://flake8.pycqa.org/en/latest/user/error-codes.html#error-violation-codes | ||
# * Default errors and warnings reported by pycodestyle (E and W) - | ||
# https://pycodestyle.readthedocs.io/en/latest/intro.html#error-codes | ||
# * Default errors reported by pyflakes (F) - | ||
# http://flake8.pycqa.org/en/latest/glossary.html#term-pyflakes | ||
# * Default warnings reported by flake8-bugbear (B) - | ||
# https://github.com/PyCQA/flake8-bugbear#list-of-warnings | ||
# * The B950 flake8-bugbear opinionated warning - | ||
# https://github.com/PyCQA/flake8-bugbear#opinionated-warnings | ||
select = C,E,F,W,B,B950 | ||
# Ignore flake8's default warning about maximum line length, which has | ||
# a hard stop at the configured value. Instead we use | ||
# flake8-bugbear's B950, which allows up to 10% overage. | ||
ignore = E501 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
__pycache__ | ||
.python-version |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
--- | ||
repos: | ||
- repo: https://github.com/pre-commit/pre-commit-hooks | ||
rev: v2.1.0 | ||
hooks: | ||
- id: check-executables-have-shebangs | ||
- id: check-json | ||
- id: check-merge-conflict | ||
- id: check-xml | ||
- id: debug-statements | ||
- id: detect-aws-credentials | ||
args: | ||
- --allow-missing-credentials | ||
- id: detect-private-key | ||
- id: end-of-file-fixer | ||
exclude: files/(issue|motd) | ||
- id: mixed-line-ending | ||
args: | ||
- --fix=lf | ||
- id: pretty-format-json | ||
args: | ||
- --autofix | ||
- id: requirements-txt-fixer | ||
- id: trailing-whitespace | ||
- repo: https://github.com/igorshubovych/markdownlint-cli | ||
rev: v0.14.0 | ||
hooks: | ||
- id: markdownlint | ||
# The LICENSE.md must match the license text exactly for | ||
# GitHub's autorecognition fu to work, so we should leave it | ||
# alone. | ||
exclude: LICENSE.md | ||
- repo: https://github.com/adrienverge/yamllint | ||
rev: v1.15.0 | ||
hooks: | ||
- id: yamllint | ||
- repo: https://github.com/detailyang/pre-commit-shell | ||
rev: 1.0.4 | ||
hooks: | ||
- id: shell-lint | ||
- repo: https://gitlab.com/pycqa/flake8 | ||
rev: 3.7.7 | ||
hooks: | ||
- id: flake8 | ||
- repo: https://github.com/asottile/pyupgrade | ||
rev: v1.12.0 | ||
hooks: | ||
- id: pyupgrade | ||
- repo: https://github.com/ambv/black | ||
rev: 18.9b0 | ||
hooks: | ||
- id: black | ||
- repo: https://github.com/ansible/ansible-lint.git | ||
rev: v4.1.0a0 | ||
hooks: | ||
- id: ansible-lint | ||
# files: molecule/default/playbook.yml | ||
- repo: https://github.com/antonbabenko/pre-commit-terraform.git | ||
rev: v1.11.0 | ||
hooks: | ||
- id: terraform_fmt | ||
- id: terraform_validate_no_variables | ||
- id: terraform_docs | ||
- repo: https://github.com/prettier/prettier | ||
rev: 1.16.2 | ||
hooks: | ||
- id: prettier |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Already being linted by mdl | ||
*.md | ||
# Already being linted by yamllint | ||
*.yaml | ||
*.yml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
dist: xenial | ||
language: python | ||
python: 3.7 | ||
services: docker | ||
|
||
install: | ||
- pip install --upgrade -r requirements-test.txt | ||
script: | ||
- pre-commit run --all-files | ||
- molecule test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
extends: default | ||
|
||
rules: | ||
# yamllint doesn't like when we use yes and no for true and false, | ||
# but that's pretty standard in Ansible. | ||
truthy: disable |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
# Welcome # | ||
|
||
We're so glad you're thinking about contributing to this open source | ||
project! If you're unsure or afraid of anything, just ask or submit | ||
the issue or pull request anyway. The worst that can happen is that | ||
you'll be politely asked to change something. We appreciate any sort | ||
of contribution, and don't want a wall of rules to get in the way of | ||
that. | ||
|
||
Before contributing, we encourage you to read our CONTRIBUTING policy | ||
(you are here), our [LICENSE](LICENSE.md), and our | ||
[README](README.md), all of which should be in this repository. | ||
|
||
## Issues ## | ||
|
||
If you want to report a bug or request a new feature, the most direct | ||
method is to [create an | ||
issue](https://github.com/cisagov/generic-skeleton/issues) in this | ||
repository. We recommend that you first search through existing | ||
issues (both open and closed) to check if your particular issue has | ||
already been reported. If it has then you might want to add a comment | ||
to the existing issue. If it hasn't then feel free to create a new | ||
one. | ||
|
||
## Pull requests ## | ||
|
||
If you choose to [submit a pull | ||
request](https://github.com/cisagov/generic-skeleton/pulls), you will | ||
notice that our continuous integration (CI) system runs a fairly | ||
extensive set of linters and syntax checkers. Your pull request may | ||
fail these checks, and that's OK. If you want you can stop there and | ||
wait for us to make the necessary corrections to ensure your code | ||
passes the CI checks. | ||
|
||
If you want to make the changes yourself, or if you want to become a | ||
regular contributor, then you will want to set up | ||
[pre-commit](https://pre-commit.com/) on your local machine. Once you | ||
do that, the CI checks will run locally before you even write your | ||
commit message. This speeds up your development cycle considerably. | ||
|
||
### Setting up pre-commit ### | ||
|
||
There are a few ways to do this, but we prefer to use | ||
[`pyenv`](https://github.com/pyenv/pyenv) and | ||
[`pyenv-virtualenv`](https://github.com/pyenv/pyenv-virtualenv) to | ||
create and manage a Python virtual environment specific to this | ||
project. | ||
|
||
#### Installing and using `pyenv` and `pyenv-virtualenv` #### | ||
|
||
On the Mac, installation is as simple as `brew install pyenv | ||
pyenv-virtualenv` and adding this to your profile: | ||
|
||
```bash | ||
eval "$(pyenv init -)" | ||
eval "$(pyenv virtualenv-init -)" | ||
``` | ||
|
||
For Linux you will need to find a package for your particular distro, | ||
or follow the manual instructions | ||
[here](https://github.com/pyenv/pyenv#installation) and | ||
[here](https://github.com/pyenv/pyenv-virtualenv#installation). Then | ||
you will need to add the same bit above to your profile. | ||
|
||
For a list of Python versions that are already installed and ready to | ||
use with `pyenv`, use the command `pyenv versions`. To see a list of | ||
the Python versions available to be installed and used with `pyenv` | ||
use the command `pyenv install --list`. You can read more | ||
[here](https://github.com/pyenv/pyenv/blob/master/COMMANDS.md) about | ||
the many things that `pyenv` can do. See | ||
[here](https://github.com/pyenv/pyenv-virtualenv#usage) for the | ||
additional capabilities that pyenv-virtualenv adds to the `pyenv` | ||
command. | ||
|
||
#### Creating the Python virtual environment #### | ||
|
||
Once `pyenv` and `pyenv-virtualenv` are installed on your system, you | ||
can create and configure the Python virtual environment with these | ||
commands: | ||
|
||
```bash | ||
cd generic-skeleton | ||
pyenv virtualenv <python_version_to_use> generic-skeleton | ||
pyenv local generic-skeleton | ||
pip install -r requirements-dev.txt | ||
``` | ||
|
||
#### Installing the pre-commit hook #### | ||
|
||
Now setting up pre-commit is as simple as: | ||
|
||
```bash | ||
pre-commit install | ||
``` | ||
|
||
At this point the pre-commit checks will run against any files that | ||
you attempt to commit. If you want to run the checks against the | ||
entire repo, just execute `pre-commit run --all-files`. | ||
|
||
## Public domain ## | ||
|
||
This project is in the public domain within the United States, and | ||
copyright and related rights in the work worldwide are waived through | ||
the [CC0 1.0 Universal public domain | ||
dedication](https://creativecommons.org/publicdomain/zero/1.0/). | ||
|
||
All contributions to this project will be released under the CC0 | ||
dedication. By submitting a pull request, you are agreeing to comply | ||
with this waiver of copyright interest. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,116 @@ | ||
CC0 1.0 Universal | ||
|
||
Statement of Purpose | ||
|
||
The laws of most jurisdictions throughout the world automatically confer | ||
exclusive Copyright and Related Rights (defined below) upon the creator and | ||
subsequent owner(s) (each and all, an "owner") of an original work of | ||
authorship and/or a database (each, a "Work"). | ||
|
||
Certain owners wish to permanently relinquish those rights to a Work for the | ||
purpose of contributing to a commons of creative, cultural and scientific | ||
works ("Commons") that the public can reliably and without fear of later | ||
claims of infringement build upon, modify, incorporate in other works, reuse | ||
and redistribute as freely as possible in any form whatsoever and for any | ||
purposes, including without limitation commercial purposes. These owners may | ||
contribute to the Commons to promote the ideal of a free culture and the | ||
further production of creative, cultural and scientific works, or to gain | ||
reputation or greater distribution for their Work in part through the use and | ||
efforts of others. | ||
|
||
For these and/or other purposes and motivations, and without any expectation | ||
of additional consideration or compensation, the person associating CC0 with a | ||
Work (the "Affirmer"), to the extent that he or she is an owner of Copyright | ||
and Related Rights in the Work, voluntarily elects to apply CC0 to the Work | ||
and publicly distribute the Work under its terms, with knowledge of his or her | ||
Copyright and Related Rights in the Work and the meaning and intended legal | ||
effect of CC0 on those rights. | ||
|
||
1. Copyright and Related Rights. A Work made available under CC0 may be | ||
protected by copyright and related or neighboring rights ("Copyright and | ||
Related Rights"). Copyright and Related Rights include, but are not limited | ||
to, the following: | ||
|
||
i. the right to reproduce, adapt, distribute, perform, display, communicate, | ||
and translate a Work; | ||
|
||
ii. moral rights retained by the original author(s) and/or performer(s); | ||
|
||
iii. publicity and privacy rights pertaining to a person's image or likeness | ||
depicted in a Work; | ||
|
||
iv. rights protecting against unfair competition in regards to a Work, | ||
subject to the limitations in paragraph 4(a), below; | ||
|
||
v. rights protecting the extraction, dissemination, use and reuse of data in | ||
a Work; | ||
|
||
vi. database rights (such as those arising under Directive 96/9/EC of the | ||
European Parliament and of the Council of 11 March 1996 on the legal | ||
protection of databases, and under any national implementation thereof, | ||
including any amended or successor version of such directive); and | ||
|
||
vii. other similar, equivalent or corresponding rights throughout the world | ||
based on applicable law or treaty, and any national implementations thereof. | ||
|
||
2. Waiver. To the greatest extent permitted by, but not in contravention of, | ||
applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and | ||
unconditionally waives, abandons, and surrenders all of Affirmer's Copyright | ||
and Related Rights and associated claims and causes of action, whether now | ||
known or unknown (including existing as well as future claims and causes of | ||
action), in the Work (i) in all territories worldwide, (ii) for the maximum | ||
duration provided by applicable law or treaty (including future time | ||
extensions), (iii) in any current or future medium and for any number of | ||
copies, and (iv) for any purpose whatsoever, including without limitation | ||
commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes | ||
the Waiver for the benefit of each member of the public at large and to the | ||
detriment of Affirmer's heirs and successors, fully intending that such Waiver | ||
shall not be subject to revocation, rescission, cancellation, termination, or | ||
any other legal or equitable action to disrupt the quiet enjoyment of the Work | ||
by the public as contemplated by Affirmer's express Statement of Purpose. | ||
|
||
3. Public License Fallback. Should any part of the Waiver for any reason be | ||
judged legally invalid or ineffective under applicable law, then the Waiver | ||
shall be preserved to the maximum extent permitted taking into account | ||
Affirmer's express Statement of Purpose. In addition, to the extent the Waiver | ||
is so judged Affirmer hereby grants to each affected person a royalty-free, | ||
non transferable, non sublicensable, non exclusive, irrevocable and | ||
unconditional license to exercise Affirmer's Copyright and Related Rights in | ||
the Work (i) in all territories worldwide, (ii) for the maximum duration | ||
provided by applicable law or treaty (including future time extensions), (iii) | ||
in any current or future medium and for any number of copies, and (iv) for any | ||
purpose whatsoever, including without limitation commercial, advertising or | ||
promotional purposes (the "License"). The License shall be deemed effective as | ||
of the date CC0 was applied by Affirmer to the Work. Should any part of the | ||
License for any reason be judged legally invalid or ineffective under | ||
applicable law, such partial invalidity or ineffectiveness shall not | ||
invalidate the remainder of the License, and in such case Affirmer hereby | ||
affirms that he or she will not (i) exercise any of his or her remaining | ||
Copyright and Related Rights in the Work or (ii) assert any associated claims | ||
and causes of action with respect to the Work, in either case contrary to | ||
Affirmer's express Statement of Purpose. | ||
|
||
4. Limitations and Disclaimers. | ||
|
||
a. No trademark or patent rights held by Affirmer are waived, abandoned, | ||
surrendered, licensed or otherwise affected by this document. | ||
|
||
b. Affirmer offers the Work as-is and makes no representations or warranties | ||
of any kind concerning the Work, express, implied, statutory or otherwise, | ||
including without limitation warranties of title, merchantability, fitness | ||
for a particular purpose, non infringement, or the absence of latent or | ||
other defects, accuracy, or the present or absence of errors, whether or not | ||
discoverable, all to the greatest extent permissible under applicable law. | ||
|
||
c. Affirmer disclaims responsibility for clearing rights of other persons | ||
that may apply to the Work or any use thereof, including without limitation | ||
any person's Copyright and Related Rights in the Work. Further, Affirmer | ||
disclaims responsibility for obtaining any necessary consents, permissions | ||
or other rights required for any use of the Work. | ||
|
||
d. Affirmer understands and acknowledges that Creative Commons is not a | ||
party to this document and has no duty or obligation with respect to this | ||
CC0 or use of the Work. | ||
|
||
For more information, please see | ||
<http://creativecommons.org/publicdomain/zero/1.0/> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# generic-skeleton # | ||
|
||
[](https://travis-ci.com/cisagov/generic-skeleton) | ||
|
||
This is a generic skeleton project that can be used to quickly get a | ||
new [cisagov](https://github.com/cisagov) GitHub project started. | ||
This skeleton project contains [licensing information](LICENSE.md), as | ||
well as [pre-commit hooks](https://pre-commit.com) and a [Travis | ||
CI](https://travis-ci.com) configuration appropriate for the major | ||
languages that we use. | ||
|
||
In many cases you will instead want to use one of the more specific | ||
skeleton projects derived from this one. | ||
|
||
## Contributing ## | ||
|
||
We welcome contributions! Please see [here](CONTRIBUTING.md) for | ||
details. | ||
|
||
## License ## | ||
|
||
This project is in the worldwide [public domain](LICENSE.md). | ||
|
||
This project is in the public domain within the United States, and | ||
copyright and related rights in the work worldwide are waived through | ||
the [CC0 1.0 Universal public domain | ||
dedication](https://creativecommons.org/publicdomain/zero/1.0/). | ||
|
||
All contributions to this project will be released under the CC0 | ||
dedication. By submitting a pull request, you are agreeing to comply | ||
with this waiver of copyright interest. | ||
|
||
## Author Information ## | ||
|
||
Shane Frasier - <[email protected]> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
-r requirements-test.txt | ||
ipython |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
black | ||
pre-commit | ||
pyupgrade |