Commit ecdb0baa authored by Laury Bueno's avatar Laury Bueno
Browse files

Initial commit

Pipeline #6871 failed with stages
branch = true
omit =
show_missing = True
exclude_lines =
raise NotImplementedError
root = true
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 4
indent_style = space
indent_size = 2
trim_trailing_whitespace = false
indent_style = tab
* Django Courses Notes 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.
# C extensions
# Packages
# Installer logs
# Unit test / coverage reports
# Translations
# Mr Developer
# Pycharm/Intellij
# Complexity
# Sphinx
# Config file for automatic testing at
language: python
- "3.6"
- TOX_ENV=py36-django-20
- TOX_ENV=py35-django-20
- TOX_ENV=py34-django-20
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 test
script: tox -e $TOX_ENV
- codecov -e TOX_ENV
Development Lead
* hacklab/ <>
None yet. Why not be the first?
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
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 Courses Notes could always use more documentation, whether as part of the
official Django Courses Notes 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
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-courses-notes` for local development.
1. Fork the `django-courses-notes` repo on GitHub.
2. Clone your fork locally::
$ git clone
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-courses-notes
$ cd django-courses-notes/
$ python 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 django_courses_notes tests
$ python 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 2.6, 2.7, and 3.3, and for PyPy. Check
and make sure that the tests pass for all supported Python versions.
To run a subset of tests::
$ python -m unittest tests.test_django_courses_notes
.. :changelog:
0.0.1 (2019-01-21)
* First release on PyPI.
include AUTHORS.rst
include CONTRIBUTING.rst
include HISTORY.rst
include LICENSE
include README.rst
recursive-include django_courses_notes *.html *.png *.gif *js *.css *jpg *jpeg *svg *py
.PHONY: clean-pyc clean-build docs help
import os, webbrowser, sys
from urllib import pathname2url
from urllib.request import pathname2url"file://" + pathname2url(os.path.abspath(sys.argv[1])))
@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 django_courses_notes tests
test: ## run tests quickly with the default Python
python tests
test-all: ## run tests on every Python version with tox
coverage: ## check code coverage quickly with the default Python
coverage run --source django_courses_notes tests
coverage report -m
coverage html
open htmlcov/index.html
docs: ## generate Sphinx HTML documentation, including API docs
rm -f docs/django-courses-notes.rst
rm -f docs/modules.rst
sphinx-apidoc -o docs/ django_courses_notes
$(MAKE) -C docs clean
$(MAKE) -C docs html
$(BROWSER) docs/_build/html/index.html
release: clean ## package and upload a release
python sdist upload
python bdist_wheel upload
sdist: clean ## package
python sdist
ls -l dist
Django Courses Notes
.. image::
.. image::
.. image::
Notes support for the Django Courses app
The full documentation is at
Install Django Courses Notes::
pip install django-courses-notes
Add it to your `INSTALLED_APPS`:
.. code-block:: python
Add Django Courses Notes's URL patterns:
.. code-block:: python
from django_courses_notes import urls as django_courses_notes_urls
urlpatterns = [
url(r'^', include(django_courses_notes_urls)),
Running Tests
Does the code actually work?
source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox
Tools used in rendering this package:
* Cookiecutter_
* `cookiecutter-djangopackage`_
.. _Cookiecutter:
.. _`cookiecutter-djangopackage`:
# -*- coding: utf-8
from django.apps import AppConfig
class DjangoCoursesNotesConfig(AppConfig):
name = 'django_courses_notes'
# -*- coding: utf-8 -*-
{% comment %}
As the developer of this package, don't place anything here if you can help it
since this allows developers to have interoperability between your template
structure and their own.
Example: Developer melding the 2SoD pattern to fit inside with another pattern::
{% extends "base.html" %}
{% load static %}
<!-- Their site uses old school block layout -->
{% block extra_js %}
<!-- Your package using 2SoD block layout -->
{% block javascript %}
<script src="{% static 'js/ninja.js' %}" type="text/javascript"></script>
{% endblock javascript %}
{% endblock extra_js %}
{% endcomment %}
# -*- coding: utf-8 -*-
from django.conf.urls import url
from django.views.generic import TemplateView
from . import views
app_name = 'django_courses_notes'
urlpatterns = [
url(r'', TemplateView.as_view(template_name="base.html")),
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment