Skip to content

Commit 7028f65

Browse files
genomics-geekgenomics-geek
committed
Merge branch 'release-0.1.0'
2 parents dfbcc7a + 96eda2a commit 7028f65

33 files changed

+2028
-67
lines changed

‎.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ pip-log.txt
2727
.tox
2828
nosetests.xml
2929
htmlcov
30+
.cache
31+
testing.db
3032

3133
# Translations
3234
*.mo

‎README.rst

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ Django User Activities
55
.. image:: https://badge.fury.io/py/django-user-activities.svg
66
:target: https://badge.fury.io/py/django-user-activities
77

8-
.. image:: https://travis-ci.org/genomics-geek/django-user-activities.svg?branch=master
9-
:target: https://travis-ci.org/genomics-geek/django-user-activities
8+
.. image:: https://travis-ci.org/chopdgd/django-user-activities.svg?branch=develop
9+
:target: https://travis-ci.org/chopdgd/django-user-activities
1010

11-
.. image:: https://codecov.io/gh/genomics-geek/django-user-activities/branch/master/graph/badge.svg
12-
:target: https://codecov.io/gh/genomics-geek/django-user-activities
11+
.. image:: https://codecov.io/gh/chopdgd/django-user-activities/branch/develop/graph/badge.svg
12+
:target: https://codecov.io/gh/chopdgd/django-user-activities
1313

1414
.. image:: https://pyup.io/repos/github/chopdgd/django-user-activities/shield.svg
1515
:target: https://pyup.io/repos/github/chopdgd/django-user-activities/
@@ -39,7 +39,7 @@ Add it to your `INSTALLED_APPS`:
3939
4040
INSTALLED_APPS = (
4141
...
42-
'user_activities.apps.UserActivitiesConfig',
42+
'user_activities',
4343
...
4444
)
4545
@@ -52,10 +52,23 @@ Add Django User Activities's URL patterns:
5252
5353
urlpatterns = [
5454
...
55-
url(r'^', include(user_activities_urls)),
55+
url(r'^', include(user_activities_urls, namespace='user_activities')),
5656
...
5757
]
5858
59+
Using Activity, Comment, or Review in your models:
60+
61+
.. code-block:: python
62+
63+
from django.contrib.contenttypes.fields import GenericRelation
64+
from django.db import models
65+
66+
67+
class ExampleModel(models.Model):
68+
...
69+
comments = GenericRelation('user_activities.Comment')
70+
user_activities = GenericRelation('user_activities.Activity')
71+
5972
Features
6073
--------
6174

‎docs/conf.py

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,11 @@
1111
# All configuration values have a default; values that are commented out
1212
# serve to show the default.
1313

14-
import sys, os
14+
import os
15+
import sys
16+
17+
import django
18+
import sphinx_rtd_theme
1519

1620
# If extensions (or modules to document with autodoc) are in another directory,
1721
# add these directories to sys.path here. If the directory is relative to the
@@ -21,6 +25,8 @@
2125
cwd = os.getcwd()
2226
parent = os.path.dirname(cwd)
2327
sys.path.append(parent)
28+
os.environ['DJANGO_SETTINGS_MODULE'] = 'tests.settings'
29+
django.setup()
2430

2531
import user_activities
2632

@@ -31,7 +37,7 @@
3137

3238
# Add any Sphinx extension module names here, as strings. They can be extensions
3339
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
34-
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
40+
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinxcontrib.napoleon']
3541

3642
# Add any paths that contain templates here, relative to this directory.
3743
templates_path = ['_templates']
@@ -100,15 +106,15 @@
100106

101107
# The theme to use for HTML and HTML Help pages. See the documentation for
102108
# a list of builtin themes.
103-
html_theme = 'default'
109+
html_theme = 'sphinx_rtd_theme'
104110

105111
# Theme options are theme-specific and customize the look and feel of a theme
106112
# further. For a list of options available for each theme, see the
107113
# documentation.
108114
#html_theme_options = {}
109115

110116
# Add any paths that contain custom themes here, relative to this directory.
111-
#html_theme_path = []
117+
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
112118

113119
# The name for this set of Sphinx documents. If None, it defaults to
114120
# "<project> v<release> documentation".

‎docs/modules.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
user_activities
2+
===============
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
7+
user_activities

‎docs/user_activities.migrations.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
user\_activities\.migrations package
2+
====================================
3+
4+
Submodules
5+
----------
6+
7+
user\_activities\.migrations\.0001\_initial module
8+
--------------------------------------------------
9+
10+
.. automodule:: user_activities.migrations.0001_initial
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
16+
Module contents
17+
---------------
18+
19+
.. automodule:: user_activities.migrations
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:

‎docs/user_activities.rst

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
user\_activities package
2+
========================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
9+
user_activities.migrations
10+
11+
Submodules
12+
----------
13+
14+
user\_activities\.admin module
15+
------------------------------
16+
17+
.. automodule:: user_activities.admin
18+
:members:
19+
:undoc-members:
20+
:show-inheritance:
21+
22+
user\_activities\.apps module
23+
-----------------------------
24+
25+
.. automodule:: user_activities.apps
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
29+
30+
user\_activities\.choices module
31+
--------------------------------
32+
33+
.. automodule:: user_activities.choices
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:
37+
38+
user\_activities\.fields module
39+
-------------------------------
40+
41+
.. automodule:: user_activities.fields
42+
:members:
43+
:undoc-members:
44+
:show-inheritance:
45+
46+
user\_activities\.filters module
47+
--------------------------------
48+
49+
.. automodule:: user_activities.filters
50+
:members:
51+
:undoc-members:
52+
:show-inheritance:
53+
54+
user\_activities\.managers module
55+
---------------------------------
56+
57+
.. automodule:: user_activities.managers
58+
:members:
59+
:undoc-members:
60+
:show-inheritance:
61+
62+
user\_activities\.models module
63+
-------------------------------
64+
65+
.. automodule:: user_activities.models
66+
:members:
67+
:undoc-members:
68+
:show-inheritance:
69+
70+
user\_activities\.serializers module
71+
------------------------------------
72+
73+
.. automodule:: user_activities.serializers
74+
:members:
75+
:undoc-members:
76+
:show-inheritance:
77+
78+
user\_activities\.urls module
79+
-----------------------------
80+
81+
.. automodule:: user_activities.urls
82+
:members:
83+
:undoc-members:
84+
:show-inheritance:
85+
86+
user\_activities\.views module
87+
------------------------------
88+
89+
.. automodule:: user_activities.views
90+
:members:
91+
:undoc-members:
92+
:show-inheritance:
93+
94+
user\_activities\.viewsets module
95+
---------------------------------
96+
97+
.. automodule:: user_activities.viewsets
98+
:members:
99+
:undoc-members:
100+
:show-inheritance:
101+
102+
103+
Module contents
104+
---------------
105+
106+
.. automodule:: user_activities
107+
:members:
108+
:undoc-members:
109+
:show-inheritance:

‎requirements.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,8 @@
11

22
# Additional requirements go here
3+
4+
djangorestframework==3.7.7
5+
6+
django-filter==1.1.0
7+
django-genomix==0.1.0
8+
django-model-utils==3.0.0

‎requirements_test.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
coverage==4.4.2
2-
mock>=1.0.1
3-
flake8>=2.1.0
4-
tox>=1.7.0
5-
codecov>=2.0.0
2+
mock==2.0.0
3+
flake8==3.5.0
4+
tox==2.9.1
5+
codecov==2.0.10
66

77

88
# Additional test requirements go here

‎setup.cfg

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,19 @@ current_version = 0.2.0
33
commit = True
44
tag = True
55

6-
[bumpversion:file:genomix_users/__init__.py]
6+
[bumpversion:file:user_activities/__init__.py]
77

88
[wheel]
99
universal = 1
1010

1111
[flake8]
1212
ignore = D203
13-
exclude =
13+
exclude =
1414
genomix_users/migrations,
1515
.git,
1616
.tox,
1717
docs/conf.py,
1818
build,
1919
dist
2020
max-line-length = 119
21+

‎setup.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,16 +56,20 @@ def get_version(*file_paths):
5656
'user_activities',
5757
],
5858
include_package_data=True,
59-
install_requires=[],
59+
install_requires=[
60+
'djangorestframework==3.7.3',
61+
'django-filter==1.1.0',
62+
'django-genomix==0.1.0',
63+
'django-model-utils==3.0.0',
64+
],
6065
license="MIT",
6166
zip_safe=False,
6267
keywords='django-user-activities',
6368
classifiers=[
6469
'Development Status :: 3 - Alpha',
6570
'Framework :: Django',
66-
'Framework :: Django :: 1.8',
67-
'Framework :: Django :: 1.9',
6871
'Framework :: Django :: 1.10',
72+
'Framework :: Django :: 1.11',
6973
'Intended Audience :: Developers',
7074
'License :: OSI Approved :: BSD License',
7175
'Natural Language :: English',

0 commit comments

Comments
 (0)