-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #13 from Bernardo-MG/develop
Develop
- Loading branch information
Showing
15 changed files
with
130 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
========= | ||
Code docs | ||
========= | ||
|
||
.. toctree:: | ||
|
||
placeholder |
9 changes: 9 additions & 0 deletions
9
{{cookiecutter.package_name}}/docs/source/code/placeholder.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
================== | ||
Placeholder module | ||
================== | ||
|
||
.. automodule:: placeholder | ||
:members: | ||
:undoc-members: | ||
:inherited-members: | ||
:show-inheritance: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,3 +19,4 @@ Features | |
acquire | ||
usage | ||
reports | ||
code/index |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,5 +3,5 @@ setuptools==26.1.1 | |
twine==1.8.1 | ||
|
||
# Documentation | ||
sphinx-docs-theme==0.2.0 | ||
sphinx-docs-theme==0.2.3 | ||
Pygments==2.1.3 |
62 changes: 62 additions & 0 deletions
62
{{cookiecutter.package_name}}/{{cookiecutter.package_name}}/placeholder.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# -*- coding: utf-8 -*- | ||
|
||
from abc import ABCMeta, abstractmethod | ||
|
||
""" | ||
Placeholder classes. | ||
Replace this module for the actual code. | ||
""" | ||
|
||
__author__ = '{{ cookiecutter.developer_name }}' | ||
__license__ = 'MIT' | ||
|
||
|
||
class AbstractPlaceholder(object): | ||
""" | ||
Placeholde for an abstract class. | ||
""" | ||
__metaclass__ = ABCMeta | ||
|
||
def __init__(self): | ||
pass | ||
|
||
@abstractmethod | ||
def method(self): | ||
""" | ||
An abstract method. | ||
""" | ||
raise NotImplementedError('The roll method must be implemented') | ||
|
||
|
||
class Placeholder(AbstractPlaceholder): | ||
""" | ||
An extension of the abstract placeholder. | ||
""" | ||
|
||
def __init__(self, data): | ||
super(Placeholder, self).__init__() | ||
self._field = data | ||
|
||
def __str__(self): | ||
return '%s' % self.field | ||
|
||
def __repr__(self): | ||
return '<class %s>(field=%r)' % \ | ||
(self.__class__.__name__, self.field) | ||
|
||
@property | ||
def field(self): | ||
""" | ||
A field in the placeholder class. | ||
:return: the field content | ||
""" | ||
return self._field | ||
|
||
@field.setter | ||
def field(self, field): | ||
self._field = field | ||
|
||
def method(self): | ||
pass |