Welcome to django-tvdb’s documentation!

Contents:

Installation

The preferred way to install django-tvdb is pip:

$ pip install django-tvdb

Alternatively, you can install download or clone this repo and install from its folder with:

$ pip install -e .

In your project, you should add django-tvdb to your requirements.txt.

Be sure to use virtualenv if you develop python projects.

Add to INSTALLED_APPS in your settings.py:

'tvdb',

After installation, the Quickstart will get you on your way to using django-tvdb.

Quickstart

After Installation, you can use django-tvdb in your project.

Demo application

The demo application provides a number of useful examples.

https://github.com/miigotu/django-tvdb/tree/develop/demo

Settings

The django-tvdb has some pre-configured settings.

They can be modified by adding a dict variable called TVDB in your settings.py and customizing the values ​​you want;

The TVDB dict variable contains these settings and defaults:

# Default settings
TVDB = {}

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

  1. Fork the django-tvdb repo on GitHub.

  2. Clone your fork locally:

    $ git clone https://github.com/your_username_here/django-tvdb.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-tvdb
$ cd django-tvdb/
$ 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 tvdb tests
$ python setup.py test
$ tox

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

  1. 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

  2. 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.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/miigotu/django-tvdb/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_tvdb

Authors

This application is developed and maintained by miigotu.

Development Lead

Contributors

  • TBD

History

0.0.1 (2016-09-18)

  • Skeleton and planning