forked from inveniosoftware/invenio-rdm-records
-
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.
- Loading branch information
0 parents
commit d168f6c
Showing
47 changed files
with
1,971 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
.git | ||
*.gitignore | ||
|
||
*.mo | ||
*.pyc | ||
*.swp | ||
*.swo | ||
*.~ | ||
|
||
.dockerignore | ||
Dockerfile | ||
docker-compose.yml | ||
docker-compose-dev.yml | ||
|
||
Procfile* |
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,40 @@ | ||
# -*- coding: utf-8 -*- | ||
# | ||
# Copyright (C) 2019 CERN. | ||
# | ||
# Invenio-RDM-Records is free software; you can redistribute it and/or modify it | ||
# under the terms of the MIT License; see LICENSE file for more details. | ||
|
||
root = true | ||
|
||
[*] | ||
indent_style = space | ||
end_of_line = lf | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true | ||
charset = utf-8 | ||
|
||
# Python files | ||
[*.py] | ||
indent_size = 4 | ||
# isort plugin configuration | ||
known_first_party = invenio_rdm_records | ||
multi_line_output = 2 | ||
default_section = THIRDPARTY | ||
skip = .eggs | ||
|
||
# RST files (used by sphinx) | ||
[*.rst] | ||
indent_size = 4 | ||
|
||
# CSS, HTML, JS, JSON, YML | ||
[*.{css,html,js,json,yml}] | ||
indent_size = 2 | ||
|
||
# Matches the exact files either package.json or .travis.yml | ||
[{package.json,.travis.yml}] | ||
indent_size = 2 | ||
|
||
# Dockerfile | ||
[Dockerfile] | ||
indent_size = 4 |
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 @@ | ||
# Byte-compiled / optimized / DLL files | ||
__pycache__/ | ||
*.py[cod] | ||
|
||
# Idea software family | ||
.idea/ | ||
|
||
# C extensions | ||
*.so | ||
|
||
# Distribution / packaging | ||
.Python | ||
env/ | ||
build/ | ||
develop-eggs/ | ||
dist/ | ||
downloads/ | ||
eggs/ | ||
.eggs/ | ||
lib/ | ||
lib64/ | ||
parts/ | ||
sdist/ | ||
var/ | ||
*.egg-info/ | ||
.installed.cfg | ||
*.egg | ||
|
||
# PyInstaller | ||
# Usually these files are written by a python script from a template | ||
# before PyInstaller builds the exe, so as to inject date/other infos into it. | ||
*.manifest | ||
*.spec | ||
|
||
# Installer logs | ||
pip-log.txt | ||
pip-delete-this-directory.txt | ||
|
||
# Unit test / coverage reports | ||
htmlcov/ | ||
.tox/ | ||
.coverage | ||
.coverage.* | ||
.cache | ||
nosetests.xml | ||
coverage.xml | ||
*,cover | ||
|
||
# Translations | ||
*.mo | ||
|
||
# Django stuff: | ||
*.log | ||
|
||
# Sphinx documentation | ||
docs/_build/ | ||
|
||
# PyBuilder | ||
target/ | ||
|
||
# Vim swapfiles | ||
.*.sw? |
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,61 @@ | ||
# -*- coding: utf-8 -*- | ||
# | ||
# Copyright (C) 2019 CERN. | ||
# | ||
# Invenio-RDM-Records is free software; you can redistribute it and/or modify it | ||
# under the terms of the MIT License; see LICENSE file for more details. | ||
|
||
notifications: | ||
email: false | ||
|
||
sudo: false | ||
|
||
language: python | ||
|
||
matrix: | ||
fast_finish: true | ||
allow_failures: | ||
# To allow failures, you need to specify the full environment | ||
- env: REQUIREMENTS=devel | ||
|
||
cache: | ||
- pip | ||
|
||
env: | ||
- REQUIREMENTS=lowest | ||
- REQUIREMENTS=release DEPLOY=true | ||
- REQUIREMENTS=devel | ||
|
||
python: | ||
- "2.7" | ||
- "3.5" | ||
|
||
before_install: | ||
- "nvm install 6; nvm use 6" | ||
- "travis_retry pip install --upgrade pip setuptools py" | ||
- "travis_retry pip install twine wheel coveralls requirements-builder" | ||
- "requirements-builder -e all --level=min setup.py > .travis-lowest-requirements.txt" | ||
- "requirements-builder -e all --level=pypi setup.py > .travis-release-requirements.txt" | ||
- "requirements-builder -e all --level=dev --req requirements-devel.txt setup.py > .travis-devel-requirements.txt" | ||
|
||
install: | ||
- "travis_retry pip install -r .travis-${REQUIREMENTS}-requirements.txt" | ||
- "travis_retry pip install -e .[all]" | ||
|
||
script: | ||
- "./run-tests.sh" | ||
|
||
after_success: | ||
- coveralls | ||
|
||
deploy: | ||
provider: pypi | ||
user: inveniosoftware | ||
password: | ||
secure: TODO:PYPISECUREHASH | ||
distributions: "compile_catalog sdist bdist_wheel" | ||
on: | ||
tags: true | ||
python: "2.7" | ||
repo: inveniosoftware/invenio-rdm-records | ||
condition: $DEPLOY = true |
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,32 @@ | ||
# -*- coding: utf-8 -*- | ||
# | ||
# Copyright (C) 2019 CERN. | ||
# | ||
# Invenio-RDM-Records is free software; you can redistribute it and/or modify it | ||
# under the terms of the MIT License; see LICENSE file for more details. | ||
|
||
# TODO: Transifex integration | ||
# | ||
# 1) Create message catalog: | ||
# $ python setup.py extract_messages | ||
# $ python setup.py init_catalog -l <lang> | ||
# $ python setup.py compile_catalog | ||
# 2) Ensure project has been created on Transifex under the inveniosoftware | ||
# organisation. | ||
# 3) Install the transifex-client | ||
# $ pip install transifex-client | ||
# 4) Push source (.pot) and translations (.po) to Transifex | ||
# $ tx push -s -t | ||
# 5) Pull translations for a single language from Transifex | ||
# $ tx pull -l <lang> | ||
# 6) Pull translations for all languages from Transifex | ||
# $ tx pull -a | ||
|
||
[main] | ||
host = https://www.transifex.com | ||
|
||
[invenio.invenio-rdm-records-messages] | ||
file_filter = invenio_rdm_records/translations/<lang>/LC_MESSAGES/messages.po | ||
source_file = invenio_rdm_records/translations/messages.pot | ||
source_lang = en | ||
type = PO |
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,13 @@ | ||
.. | ||
Copyright (C) 2019 CERN. | ||
Invenio-RDM-Records is free software; you can redistribute it and/or | ||
modify it under the terms of the MIT License; see LICENSE file for more | ||
details. | ||
|
||
Authors | ||
======= | ||
|
||
DataCite-based data model for Invenio. | ||
|
||
- CERN <[email protected]> |
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,13 @@ | ||
.. | ||
Copyright (C) 2019 CERN. | ||
Invenio-RDM-Records is free software; you can redistribute it and/or | ||
modify it under the terms of the MIT License; see LICENSE file for more | ||
details. | ||
|
||
Changes | ||
======= | ||
|
||
Version 0.1.0 (released TBD) | ||
|
||
- Initial public release. |
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,118 @@ | ||
Contributing | ||
============ | ||
|
||
Contributions are welcome, and they are greatly appreciated! Every | ||
little bit helps, and credit will always be given. | ||
|
||
Types of Contributions | ||
---------------------- | ||
|
||
Report Bugs | ||
~~~~~~~~~~~ | ||
|
||
Report bugs at https://github.com/inveniosoftware/invenio-rdm-records/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 | ||
~~~~~~~~~~~~~~~~~~~ | ||
|
||
Invenio-RDM-Records could always use more documentation, whether as part of the | ||
official Invenio-RDM-Records 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/inveniosoftware/invenio-rdm-records/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 `invenio-rdm-records` for local development. | ||
|
||
1. Fork the `inveniosoftware/invenio-rdm-records` repo on GitHub. | ||
2. Clone your fork locally: | ||
|
||
.. code-block:: console | ||
$ git clone [email protected]:your_name_here/invenio-rdm-records.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: | ||
|
||
.. code-block:: console | ||
$ mkvirtualenv invenio-rdm-records | ||
$ cd invenio-rdm-records/ | ||
$ pip install -e .[all] | ||
4. Create a branch for local development: | ||
|
||
.. code-block:: console | ||
$ 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 tests: | ||
|
||
.. code-block:: console | ||
$ ./run-tests.sh | ||
The tests will provide you with test coverage and also check PEP8 | ||
(code style), PEP257 (documentation), flake8 as well as build the Sphinx | ||
documentation and run doctests. | ||
|
||
6. Commit your changes and push your branch to GitHub: | ||
|
||
.. code-block:: console | ||
$ git add . | ||
$ git commit -s | ||
-m "component: title without verbs" | ||
-m "* NEW Adds your new feature." | ||
-m "* FIX Fixes an existing issue." | ||
-m "* BETTER Improves and existing feature." | ||
-m "* Changes something that should not be visible in release notes." | ||
$ 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 and must not decrease test coverage. | ||
2. If the pull request adds functionality, the docs should be updated. Put | ||
your new functionality into a function with a docstring. | ||
3. The pull request should work for Python 2.7, 3.5 and 3.6. Check | ||
https://travis-ci.org/inveniosoftware/invenio-rdm-records/pull_requests | ||
and make sure that the tests pass for all supported Python versions. |
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,8 @@ | ||
Installation | ||
============ | ||
|
||
Invenio-RDM-Records is on PyPI so all you need is: | ||
|
||
.. code-block:: console | ||
$ pip install invenio-rdm-records |
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,21 @@ | ||
MIT License | ||
|
||
Copyright (C) 2019 CERN. | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of | ||
this software and associated documentation files (the "Software"), to deal in | ||
the Software without restriction, including without limitation the rights to | ||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies | ||
of the Software, and to permit persons to whom the Software is furnished to do | ||
so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
Oops, something went wrong.