Skip to content

Commit 12f2122

Browse files
rgreinhorgreinho
committed
Initial Cookiecutter Commit.
0 parents  commit 12f2122

39 files changed

+1406
-0
lines changed

‎.circleci/config.yml

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
working_directory: &working_directory
2+
~/project
3+
4+
defaults: &defaults
5+
docker:
6+
- image: circleci/python:3.7.0-stretch-node
7+
working_directory: *working_directory
8+
9+
repo_cache_key: &repo_cache_key
10+
deps-{{ checksum "requirements.txt" }}-{{ checksum "requirements-dev.txt" }}
11+
12+
version: 2
13+
jobs:
14+
prepare:
15+
<<: *defaults
16+
steps:
17+
- checkout
18+
- restore_cache:
19+
keys: *repo_cache_key
20+
- run:
21+
name: prepare environment
22+
command: make venv
23+
- save_cache:
24+
paths:
25+
- ./venv
26+
key: *repo_cache_key
27+
- persist_to_workspace:
28+
root: *working_directory
29+
paths: venv/*
30+
31+
format:
32+
<<: *defaults
33+
steps:
34+
- checkout
35+
- attach_workspace:
36+
at: *working_directory
37+
- run:
38+
name: check formatter
39+
command: make lint-format
40+
41+
lint:
42+
<<: *defaults
43+
steps:
44+
- checkout
45+
- attach_workspace:
46+
at: *working_directory
47+
- run:
48+
name: run linters
49+
command: make lint
50+
51+
docs:
52+
<<: *defaults
53+
steps:
54+
- checkout
55+
- attach_workspace:
56+
at: *working_directory
57+
- run:
58+
name: run doc tests
59+
command: make docs
60+
61+
test:
62+
<<: *defaults
63+
steps:
64+
- checkout
65+
- attach_workspace:
66+
at: *working_directory
67+
- run:
68+
name: run unit tests
69+
command: |
70+
make test
71+
- store_test_results:
72+
path: test-results
73+
74+
workflows:
75+
version: 2
76+
gates:
77+
jobs:
78+
- prepare
79+
- format:
80+
requires:
81+
- prepare
82+
- lint:
83+
requires:
84+
- prepare
85+
- docs:
86+
requires:
87+
- prepare
88+
- test:
89+
requires:
90+
- prepare

‎.coveragerc

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[run]
2+
omit =
3+
*__init__.py
4+
scrapd/main.py
5+
scrapd/tests/*
6+
scrapd/cli/cli.py

‎.dockerignore

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
*.egg-info/
2+
.git/
3+
.tox/
4+
build/
5+
dist/
6+
venv/

‎.editorconfig

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
end_of_line = lf
6+
indent_size = 2
7+
indent_style = space
8+
insert_final_newline = true
9+
trim_trailing_whitespace = true
10+
11+
[*.py]
12+
indent_size = 4
13+
14+
[Makefile]
15+
indent_style = tab

‎.github/CONTRIBUTING.rst

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
Contributing
2+
============
3+
4+
We are interested in various different kinds of improvement for scrapd; please feel free to
5+
raise an `Issue`_ if you would like to work on something major to ensure efficient collaboration and avoid duplicate
6+
effort.
7+
8+
Guidelines
9+
----------
10+
11+
Use the provided templates to file an `Issue`_ or a `Pull Request`_.
12+
13+
Create a topic branch from where you want to base your work.
14+
15+
For formatting the files properly, please use `YAPF`_.In the root directory of the project, run the following command:
16+
17+
.. code-block:: bash
18+
19+
make format
20+
21+
Make sure you added tests to validate your changes.
22+
23+
Run all the tests to ensure nothing else was accidentally broken.
24+
25+
Commit messages must start with a capitalized and short summary (max. 50 chars) written in the imperative, followed by
26+
an optional, more detailed explanatory text which is separated from the summary by an empty line.
27+
28+
Commit messages should follow best practices, including explaining the context of the problem and how it was solved,
29+
including in caveats or follow up changes required. They should tell the story of the change and provide readers
30+
understanding of what led to it. Please refer to `How to Write a Git Commit Message`_ for more details.
31+
32+
Formatting your code
33+
--------------------
34+
35+
There is also a lot of YAPF plugins available for different editors. Here are a few:
36+
37+
* `atom.io <https://atom.io/packages/python-yapf>`_
38+
* `emacs <https://github.com/paetzke/py-yapf.el>`_
39+
* `sublime text <https://github.com/jason-kane/PyYapf>`_
40+
* `vim <https://github.com/google/yapf/blob/master/plugins/yapf.vim>`_
41+
42+
.. _`Issue`: https://github.com/rgreinho/scrapd/issues
43+
.. _`Pull Request`: https://github.com/rgreinho/scrapd/pulls
44+
.. _`YAPF`: https://github.com/google/yapf
45+
.. _`How to Write a Git Commit Message`: http://chris.beams.io/posts/git-commit

‎.github/ISSUE_TEMPLATE.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<!-- Provide a general summary of the issue in the Title above. -->
2+
3+
Issue Type
4+
----------
5+
<!-- Define the type of issue you are reporting. -->
6+
- Bug report
7+
- Feature request
8+
9+
Current Behavior
10+
----------------
11+
<!-- Tell us what is currently happening. -->
12+
13+
14+
Expected Behavior
15+
-----------------
16+
<!--
17+
If you are reporting a bug, tell us what should happen.
18+
If you are suggesting a change/improvement, tell us how it should work,
19+
how it differs from the current implementation.
20+
-->
21+
22+
23+
Possible Solution
24+
-----------------
25+
<!--
26+
Suggest a fix/reason for the bug, or ideas how to implement the
27+
addition or change. Delete if not applicable/relevant.
28+
-->
29+
30+
31+
<!-- ---------------------------------------------------------- -->
32+
<!-- Information bellow this line is *ONLY* for bug reports. -->
33+
<!-- Delete these sections if you're filing a Feature request. -->
34+
<!-- ---------------------------------------------------------- -->
35+
Steps to Reproduce
36+
------------------
37+
<!--
38+
Provide a link to a live example, or an unambiguous set of steps to
39+
reproduce this bug. Include code to reproduce, if relevant.
40+
-->
41+
1.
42+
2.
43+
3.
44+
45+
46+
Context
47+
-------
48+
<!--
49+
How has this issue affected you? What are you trying to accomplish?
50+
Providing context helps us come up with a solution that is most useful
51+
in the real world.
52+
-->

‎.github/PULL_REQUEST_TEMPLATE.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
Types of changes
2+
----------------
3+
<!--
4+
What types of changes does your code introduce?
5+
Select all the choices that apply:
6+
-->
7+
- Bug fix (non-breaking change which fixes an issue)
8+
- New feature (non-breaking change which adds functionality)
9+
- Breaking change (fix or feature that would cause existing functionality to change)
10+
- Code cleanup / Refactoring
11+
- Documentation
12+
13+
Description
14+
-----------
15+
<!--
16+
Describe your changes in detail.
17+
Add a screenshot if applicable.
18+
-->
19+
20+
21+
<!--
22+
Motivation and Context
23+
Why is this change required? What problem does it solve? -->
24+
25+
26+
<!--
27+
How Has This Been Tested?
28+
Add any information that could help the reviewer to validate the PR.
29+
Please describe in detail how you tested your changes, include details
30+
of your testing environment, and the tests you ran to see how your
31+
change affects other areas of the code, etc.
32+
-->
33+
34+
35+
Checklist:
36+
----------
37+
<!--
38+
Go over all the following points, and put an `x` in all the boxes that
39+
apply. If you're unsure about any of these, don't hesitate to ask.
40+
We're here to help!
41+
-->
42+
43+
- [] I have updated the documentation accordingly
44+
- [] I have written unit tests
45+
46+
<!--
47+
Place the URL of the issue here it this PR fixes an existing issue.
48+
Use either the *FULL* URL (preferred) or the `Username/Repository#`
49+
syntax.
50+
-->
51+
52+
Fixes: https://github.com/rgreinho/scrapd/<issue_number>

‎.gitignore

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
*.egg
2+
*.egg-info/
3+
*.log
4+
*.manifest
5+
*.mo
6+
*.pot
7+
*.py[cod]
8+
*.so
9+
*.spec
10+
.DS_Store
11+
.Python
12+
.cache
13+
.coverage
14+
.coverage.*
15+
.eggs/
16+
.idea/
17+
.installed.cfg
18+
.tox/
19+
.vscode/
20+
__pycache__/
21+
build/
22+
coverage.xml
23+
develop-eggs/
24+
dist/
25+
docs/_build/
26+
downloads/
27+
eggs/
28+
env/
29+
htmlcov/
30+
lib/
31+
lib64/
32+
nosetests.xml
33+
parts/
34+
pip-delete-this-directory.txt
35+
pip-log.txt
36+
sdist/
37+
target/
38+
var/
39+
venv/

‎.mergify.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
pull_request_rules:
2+
- actions:
3+
merge:
4+
method: squash
5+
rebase_fallback: merge
6+
conditions:
7+
- label!=no-mergify
8+
- '#approved-reviews-by>=1'
9+
- 'status-success=ci/circleci: docs'
10+
- 'status-success=ci/circleci: format'
11+
- 'status-success=ci/circleci: lint'
12+
- 'status-success=ci/circleci: prepare'
13+
- 'status-success=ci/circleci: test'
14+
name: master

0 commit comments

Comments
 (0)