From 1082c7b55c82d9721b0f51333f493421ae3f3d7c Mon Sep 17 00:00:00 2001 From: Maximilian Moser <maximilian.moser@tuwien.ac.at> Date: Tue, 1 Oct 2024 17:50:40 +0200 Subject: [PATCH] Various clean-ups --- CONTRIBUTING.rst | 116 ---------------------------------- INSTALL.rst | 8 --- LICENSE | 2 +- invenio_config_tuw/startup.py | 2 +- requirements-devel.txt | 12 ---- 5 files changed, 2 insertions(+), 138 deletions(-) delete mode 100644 CONTRIBUTING.rst delete mode 100644 INSTALL.rst delete mode 100644 requirements-devel.txt diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst deleted file mode 100644 index 6cc8132..0000000 --- a/CONTRIBUTING.rst +++ /dev/null @@ -1,116 +0,0 @@ -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://gitlab.tuwien.ac.at/fairdata/invenio-config-tuw/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 GitLab issues for bugs. Anything tagged with "bug" -is open to whoever wants to implement it. - -Implement Features -~~~~~~~~~~~~~~~~~~ - -Look through the GitLab issues for features. Anything tagged with "feature" -is open to whoever wants to implement it. - -Write Documentation -~~~~~~~~~~~~~~~~~~~ - -Invenio-Config-TUW could always use more documentation, whether as part of the -official Invenio-Config-TUW 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://gitlab.tuwien.ac.at/fairdata/invenio-config-tuw/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-config-tuw` for local development. - -1. Fork the `fairdata/invenio-config-tuw` repo on the TU Wien GitLab. -2. Clone your fork locally: - - .. code-block:: console - - $ git clone git@gitlab.tuwien.ac.at:your_name_here/invenio-config-tuw.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-config-tuw - $ cd invenio-config-tuw/ - $ 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 GitLab: - - .. 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 merge request through the TU Wien GitLab website. - -Merge Request Guidelines ------------------------- - -Before you submit a merge request, check that it meets these guidelines: - -1. The merge request should include tests and must not decrease test coverage. -2. If the merge request adds functionality, the docs should be updated. Put - your new functionality into a function with a docstring. -3. The merge request should work for Python 3.8+. diff --git a/INSTALL.rst b/INSTALL.rst deleted file mode 100644 index 3cd9ee0..0000000 --- a/INSTALL.rst +++ /dev/null @@ -1,8 +0,0 @@ -Installation -============ - -Invenio-Config-TUW is on PyPI so all you need is: - -.. code-block:: console - - $ pip install invenio-config-tuw diff --git a/LICENSE b/LICENSE index 5a4efe1..8f1fd27 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (C) 2020 - 2021 TU Wien. +Copyright (C) 2020 - 2024 TU Wien. 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 diff --git a/invenio_config_tuw/startup.py b/invenio_config_tuw/startup.py index 6da47e9..019577d 100644 --- a/invenio_config_tuw/startup.py +++ b/invenio_config_tuw/startup.py @@ -5,7 +5,7 @@ # Invenio-Config-TUW is free software; you can redistribute it and/or modify # it under the terms of the MIT License; see LICENSE file for more details. -"""Invenio-Theme-TUW hacks and overrides to be applied on application startup. +"""Invenio-Config-TUW hacks and overrides to be applied on application startup. This module provides a blueprint whose sole purpose is to execute some code exactly once during application startup (via ``bp.record_once()``). diff --git a/requirements-devel.txt b/requirements-devel.txt deleted file mode 100644 index ce4076e..0000000 --- a/requirements-devel.txt +++ /dev/null @@ -1,12 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Copyright (C) 2020 - 2021 TU Wien. -# -# Invenio-Config-TUW 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: Add development versions of some important dependencies here to get a -# warning when there are breaking upstream changes, e.g.: -# -# -e git+git://github.com/mitsuhiko/werkzeug.git#egg=Werkzeug -# -e git+git://github.com/mitsuhiko/jinja2.git#egg=Jinja2 -- GitLab