Skip to content

Commit a0b2009

Browse files
alejandrogalloalejandrogallo
committed
Initial commit
0 parents  commit a0b2009

32 files changed

Lines changed: 1739 additions & 0 deletions

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
* python-doi version:
2+
* Python version:
3+
* Operating System:
4+
5+
### Description
6+
7+
Describe what you were trying to get done.
8+
Tell us what happened, what went wrong, and what you expected to happen.
9+
10+
### What I Did
11+
12+
```
13+
Paste the command(s) you ran and the output.
14+
If there was a crash, please include the traceback here.
15+
```

‎.gitignore‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
env/
12+
build/
13+
develop-eggs/
14+
dist/
15+
downloads/
16+
eggs/
17+
.eggs/
18+
lib/
19+
lib64/
20+
parts/
21+
sdist/
22+
var/
23+
wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
28+
# PyInstaller
29+
# Usually these files are written by a python script from a template
30+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
31+
*.manifest
32+
*.spec
33+
34+
# Installer logs
35+
pip-log.txt
36+
pip-delete-this-directory.txt
37+
38+
# Unit test / coverage reports
39+
htmlcov/
40+
.tox/
41+
.coverage
42+
.coverage.*
43+
.cache
44+
nosetests.xml
45+
coverage.xml
46+
*.cover
47+
.hypothesis/
48+
.pytest_cache/
49+
50+
# Translations
51+
*.mo
52+
*.pot
53+
54+
# Django stuff:
55+
*.log
56+
local_settings.py
57+
58+
# Flask stuff:
59+
instance/
60+
.webassets-cache
61+
62+
# Scrapy stuff:
63+
.scrapy
64+
65+
# Sphinx documentation
66+
docs/_build/
67+
68+
# PyBuilder
69+
target/
70+
71+
# Jupyter Notebook
72+
.ipynb_checkpoints
73+
74+
# pyenv
75+
.python-version
76+
77+
# celery beat schedule file
78+
celerybeat-schedule
79+
80+
# SageMath parsed files
81+
*.sage.py
82+
83+
# dotenv
84+
.env
85+
86+
# virtualenv
87+
.venv
88+
venv/
89+
ENV/
90+
91+
# Spyder project settings
92+
.spyderproject
93+
.spyproject
94+
95+
# Rope project settings
96+
.ropeproject
97+
98+
# mkdocs documentation
99+
/site
100+
101+
# mypy
102+
.mypy_cache/

‎.travis.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Config file for automatic testing at travis-ci.org
2+
3+
language: python
4+
python:
5+
- 3.6
6+
- 3.5
7+
- 3.4
8+
- 3.3
9+
10+
install:
11+
- pip install -e .[dev]
12+
- pip install coveralls
13+
14+
script:
15+
- py.test --doctest-modules --cov=doi src tests
16+
after_success:
17+
- coveralls

‎AUTHORS.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
=======
2+
Credits
3+
=======
4+
5+
Development Lead
6+
----------------
7+
8+
* Alejandro Gallo <aamsgallo@gmail.com>
9+
10+
Contributors
11+
------------
12+
13+
None yet. Why not be the first?

‎CONTRIBUTING.rst‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
.. highlight:: shell
2+
3+
============
4+
Contributing
5+
============
6+
7+
Contributions are welcome, and they are greatly appreciated! Every little bit
8+
helps, and credit will always be given.
9+
10+
Types of Contributions
11+
----------------------
12+
13+
Report Bugs
14+
~~~~~~~~~~~
15+
16+
Report bugs at https://github.com/alejandrogallo/doi/issues.
17+
18+
If you are reporting a bug, please include:
19+
20+
* Your operating system name and version.
21+
* Any details about your local setup that might be helpful in troubleshooting.
22+
* Detailed steps to reproduce the bug.
23+
24+
Fix Bugs / Implement Features
25+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26+
27+
Look through the GitHub issues for bugs or feature requests. Anybody is welcome to submit a pull request for open issues.
28+
29+
30+
Write Documentation
31+
~~~~~~~~~~~~~~~~~~~
32+
33+
python-doi could always use more documentation, whether as part of the
34+
official python-doi docs, in docstrings, or even on the web in blog posts,
35+
articles, and such.
36+
37+
Submit Feedback
38+
~~~~~~~~~~~~~~~
39+
40+
The best way to send feedback is to file an issue at https://github.com/alejandrogallo/doi/issues.
41+
42+
If you are proposing a feature:
43+
44+
* Explain in detail how it would work.
45+
* Keep the scope as narrow as possible, to make it easier to implement.
46+
* Remember that this is a volunteer-driven project, and that contributions
47+
are welcome :)
48+
49+
Get Started!
50+
------------
51+
52+
In short,
53+
54+
1. Clone the repository from ``git@github.com:alejandrogallo/doi.git``
55+
2. Fork the repo on GitHub to your personal account.
56+
3. Add your fork as a remote.
57+
4. Pull in the latest changes from the master branch.
58+
5. Create a topic branch
59+
6. Make your changes and commit them (testing locally)
60+
7. Push changes to the topic branch on *your* remote
61+
8. Make a pull request against the base master branch through the Github website of your fork.
62+
63+
The project contains a ``Makefile`` to help with development tasts. In your checked-out clone, do
64+
65+
.. code-block:: console
66+
67+
$ make help
68+
69+
to see the available make targets.
70+
71+
Pull Request Guidelines
72+
-----------------------
73+
74+
Before you submit a pull request, check that it meets these guidelines:
75+
76+
1. The pull request should include tests.
77+
2. If the pull request adds functionality, the docs should be updated. Put
78+
your new functionality into a function with a docstring, and add the
79+
feature to the list in README.rst.
80+
3. Check https://travis-ci.org/alejandrogallo/doi/pull_requests
81+
and make sure that the tests pass for all supported Python versions.
82+

‎LICENSE‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
GNU GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Python package to work with Document Object Identifier (doi)
5+
Copyright (C) 2019 Alejandro Gallo
6+
7+
This program is free software: you can redistribute it and/or modify
8+
it under the terms of the GNU General Public License as published by
9+
the Free Software Foundation, either version 3 of the License, or
10+
(at your option) any later version.
11+
12+
This program is distributed in the hope that it will be useful,
13+
but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15+
GNU General Public License for more details.
16+
17+
You should have received a copy of the GNU General Public License
18+
along with this program. If not, see <http://www.gnu.org/licenses/>.
19+
20+
Also add information on how to contact you by electronic and paper mail.
21+
22+
You should also get your employer (if you work as a programmer) or school,
23+
if any, to sign a "copyright disclaimer" for the program, if necessary.
24+
For more information on this, and how to apply and follow the GNU GPL, see
25+
<http://www.gnu.org/licenses/>.
26+
27+
The GNU General Public License does not permit incorporating your program
28+
into proprietary programs. If your program is a subroutine library, you
29+
may consider it more useful to permit linking proprietary applications with
30+
the library. If this is what you want to do, use the GNU Lesser General
31+
Public License instead of this License. But first, please read
32+
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
33+

‎MANIFEST.in‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
graft src
2+
include AUTHORS.rst
3+
include CONTRIBUTING.rst
4+
include LICENSE
5+
include README.rst
6+
7+
recursive-include tests *
8+
recursive-exclude * __pycache__
9+
recursive-exclude * *.py[co]
10+
11+
recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

0 commit comments

Comments
 (0)