Commit 1a88dc09 authored by dboe's avatar dboe
Browse files

Update template

parent 1861554d
Pipeline #78842 passed with stage
in 53 seconds
repos:
- repo: https://github.com/ambv/black
rev: stable
hooks:
- id: black
language_version: python3.6
- repo: https://gitlab.com/pycqa/flake8
rev: 3.8.3
hooks:
- id: flake8
- repo: https://gitlab.com/dboe/dough
rev: v0.1.9
hooks:
- id: readthedocs_requirements
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v3.1.0
hooks:
- id: check-json
- id: pretty-format-json
- id: check-merge-conflict
- id: check-toml
- id: check-yaml
- id: debug-statements
- id: detect-private-key
- id: end-of-file-fixer
- repo: https://github.com/asottile/blacken-docs
rev: v1.7.0
hooks:
- id: blacken-docs
......@@ -5,6 +5,12 @@
# Required
version: 2
formats: all
build:
image: latest
# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py
......@@ -14,3 +20,7 @@ python:
version: 3.7
install:
- requirements: docs/requirements.txt
- method: pip
path: .
extra_requirements:
- docs
......@@ -15,4 +15,3 @@ Contributors
------------
None yet. Why not be the first?
......@@ -15,7 +15,7 @@ Types of Contributions
Report Bugs
~~~~~~~~~~~
Report bugs at https://gitlab.com/dboe/rna/issues.
Report bugs at https://gitlab.mpcdf.mpg.de/dboe/rna/issues.
If you are reporting a bug, please include:
......@@ -23,6 +23,9 @@ If you are reporting a bug, please include:
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.
If you want quick feedback, it is helpful to mention speicific developers
(@devloper_name) or @all. This will trigger a mail to the corresponding developer(s).
Fix Bugs
~~~~~~~~
......@@ -51,7 +54,7 @@ Write Unittests or Doctests
Submit Feedback
~~~~~~~~~~~~~~~
The best way to send feedback is to file an `Issue <https://gitlab.com/dboe/rna/issues>`_.
The best way to send feedback is to file an `Issue <https://gitlab.mpcdf.mpg.de/dboe/rna/issues>`_.
If you are proposing a feature:
......@@ -68,7 +71,7 @@ Ready to contribute? Here's how to set up `rna` for local development.
1. Fork the `rna` repo.
2. Clone your fork locally::
$ git clone git@gitlab.com:dboe/rna.git
$ git clone git@gitlab.mpcdf.mpg.de:dboe/rna.git
3. Set up your fork for local development::
......@@ -108,7 +111,7 @@ Before you submit a pull request, check that it meets these guidelines:
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 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check
https://gitlab.com/dboe/rna/-/merge_requests
https://gitlab.mpcdf.mpg.de/dboe/rna/-/merge_requests
and make sure that the tests pass for all supported Python versions.
Testing
......
......@@ -73,11 +73,7 @@ update:
echo "Your status is not clean! I can not update!"; \
exit 1; \
fi
# Uninstall pre-commit
pre-commit uninstall
# Starting upgrade
cookiecutter_project_upgrader
# Install pre-commit again
pre-commit install
FORCE: ;
......@@ -10,12 +10,12 @@ Introduction to `rna`
.. ci
.. image:: https://img.shields.io/travis/dboe/rna.svg
:target: https://travis-ci.com/dboe/rna
.. image:: https://gitlab.com/dboe/rna/badges/master/pipeline.svg
:target: https://gitlab.com/dboe/rna/commits/master
.. image:: https://gitlab.mpcdf.mpg.de/dboe/rna/badges/master/pipeline.svg
:target: https://gitlab.mpcdf.mpg.de/dboe/rna/commits/master
.. coverage
.. image:: https://gitlab.com/dboe/rna/badges/master/coverage.svg
:target: https://gitlab.com/dboe/rna/commits/master
.. image:: https://gitlab.mpcdf.mpg.de/dboe/rna/badges/master/coverage.svg
:target: https://gitlab.mpcdf.mpg.de/dboe/rna/commits/master
.. readthedocs
.. image:: https://readthedocs.org/projects/rna/badge/?version=latest
......@@ -35,14 +35,13 @@ Introduction to `rna`
Basic and essential code building blocks of all pythons
Licensed under the MIT License
Licensed under the ``MIT License``
Resources
---------
* Source code: https://gitlab.com/dboe/rna
* Source code: https://gitlab.mpcdf.mpg.de/dboe/rna
* Documentation: https://rna.readthedocs.io
* test
* Pypi: https://pypi.python.org/pypi/rna
......
......@@ -30,8 +30,7 @@ source_dir = config["build_sphinx"]["source-dir"]
# -- General configuration ---------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
needs_sphinx = "2.2.0"
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
......
......@@ -11,7 +11,7 @@
"package_name": "rna",
"pypi_username": "dboe",
"remote_namespace": "dboe",
"remote_provider": "gitlab.com",
"remote_provider": "gitlab.mpcdf.mpg.de",
"remote_username": "dboe",
"summary": "Basic and essential code building blocks of all pythons"
}
......
......@@ -32,13 +32,13 @@ You can either clone the public repository:
.. code-block:: console
$ git clone git://gitlab.com/dboe/rna
$ git clone git://gitlab.mpcdf.mpg.de/dboe/rna
Or download the `tarball`_:
.. code-block:: console
$ curl -OJL https://gitlab.com/dboe/rna/tarball/master
$ curl -OJL https://gitlab.mpcdf.mpg.de/dboe/rna/tarball/master
Once you have a copy of the source, you can install it with:
......@@ -47,5 +47,5 @@ Once you have a copy of the source, you can install it with:
$ python setup.py install
.. _remote repo: https://gitlab.com/dboe/rna
.. _tarball: https://gitlab.com/dboe/rna/tarball/master
.. _remote repo: https://gitlab.mpcdf.mpg.de/dboe/rna
.. _tarball: https://gitlab.mpcdf.mpg.de/dboe/rna/tarball/master
......@@ -11,7 +11,7 @@ replace = {new_version}
[metadata]
name = rna
version = attr: rna.__version__
url = https://gitlab.com/dboe/rna
url = https://gitlab.mpcdf.mpg.de/dboe/rna
author = Daniel Böckenhoff
author_email = dboe@ipp.mpg.de
# find the full list of possible classifiers at https://pypi.org/classifiers/
......@@ -34,7 +34,7 @@ install_requires =
pathlib
project_urls =
Documentation = https://rna.readthedocs.io
Source = https://gitlab.com/dboe/rna
Source = https://gitlab.mpcdf.mpg.de/dboe/rna
tests_require =
doctest
unittest
......@@ -51,6 +51,7 @@ exclude =
all =
%(dev)s
dev =
%(docs)s
%(test)s
bumpversion # for incrementing the version
twine # for publishing
......@@ -58,6 +59,9 @@ dev =
pre-commit # https://pre-commit.com/ for hook managment
pre-commit-hooks
cookiecutter_project_upgrader
docs =
sphinx>=2.2.0 # requires templatedir option in sphinx-apidoc
sphinx_rtd_theme>=0.4.3
test =
flake8
pytest
......@@ -84,7 +88,7 @@ omit =
[flake8]
max-line-length = 99
doctests = True
exclude = .git, .eggs, __pycache__, docs, dist, venv, .tox
exclude = .git, .eggs, __pycache__, docs, dist, venv, .tox
[build_sphinx]
builder = html,man
......
from setuptools import setup
setup()
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