Skip to content

Commit

Permalink
Bare bones working first version
Browse files Browse the repository at this point in the history
  • Loading branch information
fjsj committed Feb 1, 2019
0 parents commit 6dcea8e
Show file tree
Hide file tree
Showing 68 changed files with 8,206 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 @@
* django_zombodb 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.
```
61 changes: 61 additions & 0 deletions .gitignore
@@ -0,0 +1,61 @@
*.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

# Private deps
requirement/private.in
requirement/private.txt

# Visual Studio Code
.vscode

# Local decouple env vars
.env

# Virtualenvs
venv/
env/
54 changes: 54 additions & 0 deletions .prospector.yml
@@ -0,0 +1,54 @@
output-format: text

strictness: veryhigh
test-warnings: true
doc-warnings: false
member-warnings: true

uses:
- django

pep8:
full: true
disable:
- D100
- D101
- D102
- D103
- D105
- D205
- D400
- N802 # function name should be lowercase, breaks on tests
- N806
options:
max-line-length: 100

pyflakes:
disable:
- F999

pylint:
disable:
- too-few-public-methods
- invalid-name
- no-self-use
- no-member
options:
max-line-length: 100
max-parents: 15

dodgy:
run: true

ignore-paths:
- node_modules
- venv
- env
- docs

ignore-patterns:
- .+/migrations/.+
- tests/settings.py
- setup.py
- runtests.py
- manage.py
32 changes: 32 additions & 0 deletions .travis.yml
@@ -0,0 +1,32 @@
# Config file for automatic testing at travis-ci.org

language: python

python:
- "2.7"
- "3.4"
- "3.5"
- "3.6"

env:
- DJANGO=1.11
- DJANGO=2.0

matrix:
exclude:
- python: "2.7"
env: DJANGO=2.0
include:
- python: "3.6"
env: TOXENV=quality
- python: "3.6"
env: TOXENV=docs

install:
- pip install -r requirements/travis.txt

script:
- tox

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

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

* Flávio Juvenal <flavio@vinta.com.br>

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

None yet. Why not be the first?
9 changes: 9 additions & 0 deletions CHANGELOG.rst
@@ -0,0 +1,9 @@
.. :changelog:
Change Log
----------

0.1.0 (2019-02-01)
++++++++++++++++++

* First release on PyPI.
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/fjsj/django-zombodb/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
~~~~~~~~~~~~~~~~~~~

django_zombodb could always use more documentation, whether as part of the
official django_zombodb 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/fjsj/django-zombodb/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 `django-zombodb` for local development.

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

$ git clone git@github.com:your_name_here/django-zombodb.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 django-zombodb
$ cd django-zombodb/
$ 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 prospector and the
tests, including testing other Python versions with tox::

$ prospector
$ python setup.py test
$ make test-all

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 2.7, 3.4, 3.5 and 3.6. Check
https://travis-ci.org/fjsj/django-zombodb/pull_requests
and make sure that the tests pass for all supported Python versions.

Tips
----

To run a subset of tests::

$ python runtests.py tests.test_django_zombodb
26 changes: 26 additions & 0 deletions LICENSE
@@ -0,0 +1,26 @@

MIT License

Copyright (c) 2019 Vinta Serviços e Soluções Tecnológicas Ltda

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 CHANGELOG.rst
include LICENSE
include README.rst
recursive-include django_zombodb *.html *.png *.gif *js *.css *jpg *jpeg *svg *py

0 comments on commit 6dcea8e

Please sign in to comment.