Skip to content

Commit 3f9c5ae

Browse files
paulonteripaulonteri
committed
project initialization
0 parents  commit 3f9c5ae

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+1672
-0
lines changed

‎.coveragerc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[run]
2+
branch = true
3+
4+
[report]
5+
omit =
6+
*site-packages*
7+
*tests*
8+
*.tox*
9+
show_missing = True
10+
exclude_lines =
11+
raise NotImplementedError

‎.editorconfig

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# http://editorconfig.org
2+
3+
root = true
4+
5+
[*]
6+
charset = utf-8
7+
end_of_line = lf
8+
insert_final_newline = true
9+
trim_trailing_whitespace = true
10+
11+
[*.{py,rst,ini}]
12+
indent_style = space
13+
indent_size = 4
14+
15+
[*.{html,css,scss,json,yml}]
16+
indent_style = space
17+
indent_size = 2
18+
19+
[*.md]
20+
trim_trailing_whitespace = false
21+
22+
[Makefile]
23+
indent_style = tab

‎.github/ISSUE_TEMPLATE.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
* Django Serverless Cron version:
2+
* Django version:
3+
* Python version:
4+
* Operating System:
5+
6+
### Description
7+
8+
Describe what you were trying to get done.
9+
Tell us what happened, what went wrong, and what you expected to happen.
10+
11+
### What I Did
12+
13+
```
14+
Paste the command(s) you ran and the output.
15+
If there was a crash, please include the traceback here.
16+
```

‎.gitignore

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
*.py[cod]
2+
__pycache__
3+
4+
# C extensions
5+
*.so
6+
7+
# Packages
8+
*.egg
9+
*.egg-info
10+
dist
11+
build
12+
eggs
13+
parts
14+
bin
15+
var
16+
sdist
17+
develop-eggs
18+
.installed.cfg
19+
lib
20+
lib64
21+
22+
# Installer logs
23+
pip-log.txt
24+
25+
# Unit test / coverage reports
26+
.coverage
27+
.tox
28+
nosetests.xml
29+
htmlcov
30+
31+
# Translations
32+
*.mo
33+
34+
# Mr Developer
35+
.mr.developer.cfg
36+
.project
37+
.pydevproject
38+
39+
# Pycharm/Intellij
40+
.idea
41+
42+
# Complexity
43+
output/*.html
44+
output/*/index.html
45+
46+
# Sphinx
47+
docs/_build
48+
49+
# virtual environment
50+
./venv
51+
./env

‎AUTHORS.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
=======
2+
Credits
3+
=======
4+
5+
Development Lead
6+
----------------
7+
8+
* Paul Onteri <[email protected]>
9+
10+
Contributors
11+
------------
12+
13+
None yet. Why not be the first?

‎CONTRIBUTING.rst

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
============
2+
Contributing
3+
============
4+
5+
Contributions are welcome, and they are greatly appreciated! Every
6+
little bit helps, and credit will always be given.
7+
8+
You can contribute in many ways:
9+
10+
Types of Contributions
11+
----------------------
12+
13+
Report Bugs
14+
~~~~~~~~~~~
15+
16+
Report bugs at https://github.com/paulonteri/django-serverless-cron/issues.
17+
18+
If you are reporting a bug, please include:
19+
20+
* Your operating system name and version.
21+
* Any details about your local setup that might be helpful in troubleshooting.
22+
* Detailed steps to reproduce the bug.
23+
24+
Fix Bugs
25+
~~~~~~~~
26+
27+
Look through the GitHub issues for bugs. Anything tagged with "bug"
28+
is open to whoever wants to implement it.
29+
30+
Implement Features
31+
~~~~~~~~~~~~~~~~~~
32+
33+
Look through the GitHub issues for features. Anything tagged with "feature"
34+
is open to whoever wants to implement it.
35+
36+
Write Documentation
37+
~~~~~~~~~~~~~~~~~~~
38+
39+
Django Serverless Cron could always use more documentation, whether as part of the
40+
official Django Serverless Cron docs, in docstrings, or even on the web in blog posts,
41+
articles, and such.
42+
43+
Submit Feedback
44+
~~~~~~~~~~~~~~~
45+
46+
The best way to send feedback is to file an issue at https://github.com/paulonteri/django-serverless-cron/issues.
47+
48+
If you are proposing a feature:
49+
50+
* Explain in detail how it would work.
51+
* Keep the scope as narrow as possible, to make it easier to implement.
52+
* Remember that this is a volunteer-driven project, and that contributions
53+
are welcome :)
54+
55+
Get Started!
56+
------------
57+
58+
Ready to contribute? Here's how to set up `django-serverless-cron` for local development.
59+
60+
1. Fork the `django-serverless-cron` repo on GitHub.
61+
2. Clone your fork locally::
62+
63+
$ git clone [email protected]:your_name_here/django-serverless-cron.git
64+
65+
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
66+
67+
$ mkvirtualenv django-serverless-cron
68+
$ cd django-serverless-cron/
69+
$ python setup.py develop
70+
71+
4. Create a branch for local development::
72+
73+
$ git checkout -b name-of-your-bugfix-or-feature
74+
75+
Now you can make your changes locally.
76+
77+
5. When you're done making changes, check that your changes pass flake8 and the
78+
tests, including testing other Python versions with tox::
79+
80+
$ flake8 django_serverless_cron tests
81+
$ python setup.py test
82+
$ tox
83+
84+
To get flake8 and tox, just pip install them into your virtualenv.
85+
86+
6. Commit your changes and push your branch to GitHub::
87+
88+
$ git add .
89+
$ git commit -m "Your detailed description of your changes."
90+
$ git push origin name-of-your-bugfix-or-feature
91+
92+
7. Submit a pull request through the GitHub website.
93+
94+
Pull Request Guidelines
95+
-----------------------
96+
97+
Before you submit a pull request, check that it meets these guidelines:
98+
99+
1. The pull request should include tests.
100+
2. If the pull request adds functionality, the docs should be updated. Put
101+
your new functionality into a function with a docstring, and add the
102+
feature to the list in README.rst.
103+
3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check
104+
https://travis-ci.org/paulonteri/django-serverless-cron/pull_requests
105+
and make sure that the tests pass for all supported Python versions.
106+
107+
Tips
108+
----
109+
110+
To run a subset of tests::
111+
112+
$ python -m unittest tests.test_django_serverless_cron

‎HISTORY.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. :changelog:
2+
3+
History
4+
-------
5+
6+
0.1.0 (2022-01-27)
7+
++++++++++++++++++
8+
9+
* First release on PyPI.

‎LICENSE

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

‎MANIFEST.in

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
include AUTHORS.rst
2+
include CONTRIBUTING.rst
3+
include HISTORY.rst
4+
include LICENSE
5+
include README.rst
6+
recursive-include django_serverless_cron *.html *.png *.gif *js *.css *jpg *jpeg *svg *py

‎README.rst

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
=============================
2+
Django Serverless Cron
3+
=============================
4+
5+
.. image:: https://badge.fury.io/py/django-serverless-cron.svg
6+
:target: https://badge.fury.io/py/django-serverless-cron
7+
8+
.. image:: https://travis-ci.org/paulonteri/django-serverless-cron.svg?branch=master
9+
:target: https://travis-ci.org/paulonteri/django-serverless-cron
10+
11+
.. image:: https://codecov.io/gh/paulonteri/django-serverless-cron/branch/master/graph/badge.svg
12+
:target: https://codecov.io/gh/paulonteri/django-serverless-cron
13+
14+
Django Serverless Cron
15+
16+
Documentation
17+
-------------
18+
19+
The full documentation is at https://django-serverless-cron.readthedocs.io.
20+
21+
Quickstart
22+
----------
23+
24+
Install Django Serverless Cron::
25+
26+
pip install django-serverless-cron
27+
28+
Add it to your `INSTALLED_APPS`:
29+
30+
.. code-block:: python
31+
32+
INSTALLED_APPS = (
33+
...
34+
'django_serverless_cron.apps.DjangoServerlessCronConfig',
35+
...
36+
)
37+
38+
Add Django Serverless Cron's URL patterns:
39+
40+
.. code-block:: python
41+
42+
from django_serverless_cron import urls as django_serverless_cron_urls
43+
44+
45+
urlpatterns = [
46+
...
47+
url(r'^', include(django_serverless_cron_urls)),
48+
...
49+
]
50+
51+
Features
52+
--------
53+
54+
* TODO
55+
56+
Running Tests
57+
-------------
58+
59+
Does the code actually work?
60+
61+
::
62+
63+
source <YOURVIRTUALENV>/bin/activate
64+
(myenv) $ pip install tox
65+
(myenv) $ tox
66+
67+
68+
Development commands
69+
---------------------
70+
71+
::
72+
73+
pip install -r requirements_dev.txt
74+
invoke -l
75+
76+
77+
Credits
78+
-------
79+
80+
Tools used in rendering this package:
81+
82+
* Cookiecutter_
83+
* `cookiecutter-djangopackage`_
84+
85+
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
86+
.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage

‎django_serverless_cron/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
__version__ = '0.1.0'

‎django_serverless_cron/admin.py

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# -*- coding: utf-8 -*-
2+
3+
from django.contrib import admin
4+
5+
from .models import (
6+
CronJobRun,
7+
)
8+
9+
10+
@admin.register(CronJobRun)
11+
class CronJobRunAdmin(admin.ModelAdmin):
12+
pass
13+
14+
15+

‎django_serverless_cron/apps.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# -*- coding: utf-8
2+
from django.apps import AppConfig
3+
4+
5+
class DjangoServerlessCronConfig(AppConfig):
6+
name = 'django_serverless_cron'

‎django_serverless_cron/models.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# -*- coding: utf-8 -*-
2+
3+
from django.db import models
4+
5+
6+
class CronJobRun(models.Model):
7+
pass

‎django_serverless_cron/test_utils/__init__.py

Whitespace-only changes.

‎django_serverless_cron/test_utils/test_app/__init__.py

Whitespace-only changes.

‎django_serverless_cron/test_utils/test_app/admin.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
from django.contrib import admin
2+
3+
# Put your models admin models here

‎django_serverless_cron/test_utils/test_app/apps.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
from django.apps import AppConfig
2+
3+
4+
class TestAppConfig(AppConfig):
5+
name = 'test_app'

‎django_serverless_cron/test_utils/test_app/migrations/__init__.py

Whitespace-only changes.

‎django_serverless_cron/test_utils/test_app/models.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
from django.db import models
2+
3+
# Put your test models here

0 commit comments

Comments
 (0)