Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
wgordon17 committed Feb 5, 2019
0 parents commit 86f50a7
Show file tree
Hide file tree
Showing 41 changed files with 1,540 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .coveragerc
@@ -0,0 +1,11 @@
[run]
branch = true

[report]
omit =
*site-packages*
*tests*
*.tox*
show_missing = True
exclude_lines =
raise NotImplementedError
23 changes: 23 additions & 0 deletions .editorconfig
@@ -0,0 +1,23 @@
# http://editorconfig.org

root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.{py,rst,ini}]
indent_style = space
indent_size = 4

[*.{html,css,scss,json,yml}]
indent_style = space
indent_size = 2

[*.md]
trim_trailing_whitespace = false

[Makefile]
indent_style = tab
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE.md
@@ -0,0 +1,16 @@
* Awesome Django Timezones version:
* Django version:
* Python version:
* Operating System:

### Description

Describe what you were trying to get done.
Tell us what happened, what went wrong, and what you expected to happen.

### What I Did

```
Paste the command(s) you ran and the output.
If there was a crash, please include the traceback here.
```
47 changes: 47 additions & 0 deletions .gitignore
@@ -0,0 +1,47 @@
*.py[cod]
__pycache__

# C extensions
*.so

# Packages
*.egg
*.egg-info
dist
build
eggs
parts
bin
var
sdist
develop-eggs
.installed.cfg
lib
lib64

# Installer logs
pip-log.txt

# Unit test / coverage reports
.coverage
.tox
nosetests.xml
htmlcov

# Translations
*.mo

# Mr Developer
.mr.developer.cfg
.project
.pydevproject

# Pycharm/Intellij
.idea

# Complexity
output/*.html
output/*/index.html

# Sphinx
docs/_build
20 changes: 20 additions & 0 deletions .travis.yml
@@ -0,0 +1,20 @@
# Config file for automatic testing at travis-ci.org

language: python

python:
- "3.6"

env:

matrix:
fast_finish: true

# command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
install: pip install -r requirements_test.txt

# command to run tests using coverage, e.g. python setup.py test
script: tox -e $TOX_ENV

after_success:
- codecov -e TOX_ENV
13 changes: 13 additions & 0 deletions AUTHORS.rst
@@ -0,0 +1,13 @@
=======
Credits
=======

Development Lead
----------------

* Will Gordon <will@gordoncode.com>

Contributors
------------

None yet. Why not be the first?
112 changes: 112 additions & 0 deletions CONTRIBUTING.rst
@@ -0,0 +1,112 @@
============
Contributing
============

Contributions are welcome, and they are greatly appreciated! Every
little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions
----------------------

Report Bugs
~~~~~~~~~~~

Report bugs at https://github.com/wgordon17/awesome-django-timezones/issues.

If you are reporting a bug, please include:

* Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.

Fix Bugs
~~~~~~~~

Look through the GitHub issues for bugs. Anything tagged with "bug"
is open to whoever wants to implement it.

Implement Features
~~~~~~~~~~~~~~~~~~

Look through the GitHub issues for features. Anything tagged with "feature"
is open to whoever wants to implement it.

Write Documentation
~~~~~~~~~~~~~~~~~~~

Awesome Django Timezones could always use more documentation, whether as part of the
official Awesome Django Timezones docs, in docstrings, or even on the web in blog posts,
articles, and such.

Submit Feedback
~~~~~~~~~~~~~~~

The best way to send feedback is to file an issue at https://github.com/wgordon17/awesome-django-timezones/issues.

If you are proposing a feature:

* Explain in detail how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
* Remember that this is a volunteer-driven project, and that contributions
are welcome :)

Get Started!
------------

Ready to contribute? Here's how to set up `awesome-django-timezones` for local development.

1. Fork the `awesome-django-timezones` repo on GitHub.
2. Clone your fork locally::

$ git clone git@github.com:your_name_here/awesome-django-timezones.git

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::

$ mkvirtualenv awesome-django-timezones
$ cd awesome-django-timezones/
$ python setup.py develop

4. Create a branch for local development::

$ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

5. When you're done making changes, check that your changes pass flake8 and the
tests, including testing other Python versions with tox::

$ flake8 awesome_django_timezones tests
$ python setup.py test
$ tox

To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub::

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

7. Submit a pull request through the GitHub website.

Pull Request Guidelines
-----------------------

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring, and add the
feature to the list in README.rst.
3. The pull request should work for Python 3.6+. Check
https://travis-ci.org/wgordon17/awesome-django-timezones/pull_requests
and make sure that the tests pass for all supported Python versions.

Tips
----

To run a subset of tests::

$ python -m unittest tests.test_awesome_django_timezones
9 changes: 9 additions & 0 deletions HISTORY.rst
@@ -0,0 +1,9 @@
.. :changelog:
History
-------

0.1.0 (2019-02-04)
++++++++++++++++++

* First release on PyPI.
14 changes: 14 additions & 0 deletions LICENSE
@@ -0,0 +1,14 @@

MIT License

Copyright (c) 2019, Will Gordon

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:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

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.




6 changes: 6 additions & 0 deletions MANIFEST.in
@@ -0,0 +1,6 @@
include AUTHORS.rst
include CONTRIBUTING.rst
include HISTORY.rst
include LICENSE
include README.rst
recursive-include awesome_django_timezones *.html *.png *.gif *js *.css *jpg *jpeg *svg *py
59 changes: 59 additions & 0 deletions Makefile
@@ -0,0 +1,59 @@
.PHONY: clean-pyc clean-build docs help
.DEFAULT_GOAL := help
define BROWSER_PYSCRIPT
import os, webbrowser, sys
try:
from urllib import pathname2url
except:
from urllib.request import pathname2url

webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
endef
export BROWSER_PYSCRIPT
BROWSER := python -c "$$BROWSER_PYSCRIPT"

help:
@grep '^[a-zA-Z]' $(MAKEFILE_LIST) | sort | awk -F ':.*?## ' 'NF==2 {printf "\033[36m %-25s\033[0m %s\n", $$1, $$2}'

clean: clean-build clean-pyc

clean-build: ## remove build artifacts
rm -fr build/
rm -fr dist/
rm -fr *.egg-info

clean-pyc: ## remove Python file artifacts
find . -name '*.pyc' -exec rm -f {} +
find . -name '*.pyo' -exec rm -f {} +
find . -name '*~' -exec rm -f {} +

lint: ## check style with flake8
flake8 awesome_django_timezones tests

test: ## run tests quickly with the default Python
python runtests.py tests

test-all: ## run tests on every Python version with tox
tox

coverage: ## check code coverage quickly with the default Python
coverage run --source awesome_django_timezones runtests.py tests
coverage report -m
coverage html
open htmlcov/index.html

docs: ## generate Sphinx HTML documentation, including API docs
rm -f docs/awesome-django-timezones.rst
rm -f docs/modules.rst
sphinx-apidoc -o docs/ awesome_django_timezones
$(MAKE) -C docs clean
DJANGO_SETTINGS_MODULE=tests.settings $(MAKE) -C docs html
$(BROWSER) docs/_build/html/index.html

release: clean ## package and upload a release
python setup.py sdist upload
python setup.py bdist_wheel upload

sdist: clean ## package
python setup.py sdist
ls -l dist

0 comments on commit 86f50a7

Please sign in to comment.