invenio-vcs 0.0.1__tar.gz

invenio_vcs-0.0.1/.git-blame-ignore-revs

@@ -0,0 +1 @@
+f5b70c3baf40f9549ecc64a616f8d0aa8710a976

invenio_vcs-0.0.1/AUTHORS.rst

@@ -0,0 +1,21 @@
+..
+    This file is part of Invenio-VCS.
+    Copyright (C) 2016-2026 CERN.
+
+    Invenio-VCS 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
+=======
+
+Invenio module that adds VCS integration to the platform.
+
+- Adrian Pawel Baran <adrian.pawel.baran@cern.ch>
+- Alexander Ioannidis <a.ioannidis@cern.ch>
+- Amit Kapadia <akapad@gmail.com>
+- Charlie Lewis <clewis@iqt.org>
+- Dan Blanchard <dan.blanchard@gmail.com>
+- Jiri Kuncar <jiri.kuncar@cern.ch>
+- Lars Holm Nielsen <lars.holm.nielsen@cern.ch>
+- Tibor Simko <tibor.simko@cern.ch>
+- Pal Kerecsenyi <pal.kerecsenyi@cern.ch>

invenio_vcs-0.0.1/CHANGES.rst

@@ -0,0 +1,14 @@
+..
+    This file is part of Invenio-VCS.
+    Copyright (C) 2016-2026 CERN.
+    Copyright (C) 2024-2026 Graz University of Technology.
+
+    Invenio-VCS 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.0.1 (release 2026-04-01)
+
+- initial release

invenio_vcs-0.0.1/CONTRIBUTING.rst

@@ -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-vcs/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-VCS could always use more documentation, whether as part of the
+official Invenio-GitHub 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-vcs/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-vcs` for local development.
+
+1. Fork the `invenio` repo on GitHub.
+2. Clone your fork locally:
+
+   .. code-block:: console
+
+      $ git clone git@github.com:your_name_here/invenio-vcs.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-vcs
+      $ cd invenio-vcs/
+      $ 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.3, 3.4 and 3.5. Check
+   https://travis-ci.org/inveniosoftware/invenio-vcs/pull_requests
+   and make sure that the tests pass for all supported Python versions.

invenio_vcs-0.0.1/INSTALL.rst

@@ -0,0 +1,2 @@
+Installation
+============

invenio_vcs-0.0.1/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2015-2026 CERN
+Copyright (c) 2022-2026 Graz University of Technology.
+
+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.

invenio_vcs-0.0.1/MAINTAINERS

@@ -0,0 +1,2 @@
+Lars Holm Nielsen <lars.holm.nielsen@cern.ch> (@lnielsen)
+Krzysztof Nowak <k.nowak@cern.ch> (@krzysztof)

invenio_vcs-0.0.1/MANIFEST.in

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Invenio-VCS.
+# Copyright (C) 2023-2026 CERN.
+#
+# Invenio-VCS is free software; you can redistribute it and/or modify
+# it under the terms of the MIT License; see LICENSE file for more details.
+
+exclude .dockerignore
+exclude .editorconfig
+exclude .tx/config
+exclude pytest.ini
+include *.txt
+include MAINTAINERS
+include *.rst
+include babel.ini
+include .lgtm
+include LICENSE
+include .prettierrc
+include *.yml
+include run-js-linter.sh
+include run-tests.sh
+include run-i18n-tests.sh
+prune docs/_build
+prune docs/_build
+prune tests
+recursive-include .github/workflows *.yml
+recursive-include docs *.bat
+recursive-include docs *.py
+recursive-include docs *.rst
+recursive-include docs *.txt
+recursive-include docs Makefile
+recursive-include invenio_vcs *.html
+recursive-include invenio_vcs *.js
+recursive-include invenio_vcs *.json
+recursive-include invenio_vcs *.less
+recursive-include invenio_vcs *.mo
+recursive-include invenio_vcs *.po
+recursive-include invenio_vcs *.pot
+recursive-include invenio_vcs *.py
+include .git-blame-ignore-revs

invenio_vcs-0.0.1/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.4
+Name: invenio-vcs
+Version: 0.0.1
+Summary: "Invenio module that adds VCS integration to the platform."
+Home-page: https://github.com/inveniosoftware/invenio-vcs
+Author: CERN
+Author-email: info@inveniosoftware.org
+License: MIT
+Keywords: invenio github gitlab vcs
+Platform: any
+Classifier: Development Status :: 5 - Production/Stable
+Requires-Python: >=3.7
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: Flask-Menu<3.0.0,>=2.0.0
+Requires-Dist: PyYAML>=5.4.1
+Requires-Dist: email-validator>=1.0.5
+Requires-Dist: humanize>=0.5.1
+Requires-Dist: python-dateutil<3.0.0,>=2.9.0
+Requires-Dist: invenio-assets<5.0.0,>=4.0.0
+Requires-Dist: invenio-accounts<8.0.0,>=7.0.0
+Requires-Dist: invenio-celery<3.0.0,>=2.0.0
+Requires-Dist: invenio-db[mysql,postgresql]<3.0.0,>=2.0.0
+Requires-Dist: invenio-formatter<5.0.0,>=4.0.0
+Requires-Dist: invenio-i18n<4.0.0,>=3.0.0
+Requires-Dist: invenio-oauth2server<5.0.0,>=4.0.0
+Requires-Dist: invenio-oauthclient<8.0.0,>=7.0.0
+Requires-Dist: invenio-pidstore<4.0.0,>=3.0.0
+Requires-Dist: invenio-records-rest<5.0.0,>=4.0.0
+Requires-Dist: invenio-webhooks<3.0.0,>=2.0.0
+Requires-Dist: invenio-records-resources<10.0.0,>=9.0.0
+Requires-Dist: invenio-notifications<2.0.0,>=1.0.0
+Requires-Dist: invenio-users-resources<11.0.0,>=10.0.0
+Requires-Dist: invenio-jobs<9.0.0,>=7.0.0
+Requires-Dist: mistune>=0.7.2
+Requires-Dist: six>=1.12.0
+Requires-Dist: uritemplate>=3.0.1
+Requires-Dist: click>=8.1.8
+Requires-Dist: github3.py<5.0.0,>=4.0.1
+Requires-Dist: python-gitlab<7.0.0,>=6.2.0
+Provides-Extra: tests
+Requires-Dist: httpretty>=0.8.14; extra == "tests"
+Requires-Dist: invenio-app<4.0.0,>=3.0.0; extra == "tests"
+Requires-Dist: invenio-db[mysql,postgresql]<3.0.0,>=2.0.0; extra == "tests"
+Requires-Dist: invenio-files-rest<5.0.0,>=4.0.0; extra == "tests"
+Requires-Dist: isort>=4.2.2; extra == "tests"
+Requires-Dist: pytest-black-ng>=0.4.0; extra == "tests"
+Requires-Dist: pytest-invenio<4.0.0,>=3.0.0; extra == "tests"
+Requires-Dist: pytest-mock>=2.0.0; extra == "tests"
+Requires-Dist: sphinx>=4.5.0; extra == "tests"
+Provides-Extra: elasticsearch7
+Requires-Dist: invenio-search[elasticsearch7]<4.0.0,>=3.0.0; extra == "elasticsearch7"
+Provides-Extra: opensearch1
+Requires-Dist: invenio-search[opensearch1]<4.0.0,>=3.0.0; extra == "opensearch1"
+Provides-Extra: opensearch2
+Requires-Dist: invenio-search[opensearch2]<4.0.0,>=3.0.0; extra == "opensearch2"
+Dynamic: license-file
+
+..
+    This file is part of Invenio-VCS.
+    Copyright (C) 2023-2026 CERN.
+
+    Invenio-VCS 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-VCS
+================
+
+.. image:: https://img.shields.io/travis/inveniosoftware/invenio-vcs.svg
+        :target: https://travis-ci.org/inveniosoftware/invenio-vcs
+
+.. image:: https://img.shields.io/coveralls/inveniosoftware/invenio-vcs.svg
+        :target: https://coveralls.io/r/inveniosoftware/invenio-vcs
+
+.. image:: https://img.shields.io/github/tag/inveniosoftware/invenio-vcs.svg
+        :target: https://github.com/inveniosoftware/invenio-vcs/releases
+
+.. image:: https://img.shields.io/pypi/dm/invenio-vcs.svg
+        :target: https://pypi.python.org/pypi/invenio-vcs
+
+.. image:: https://img.shields.io/github/license/inveniosoftware/invenio-vcs.svg
+        :target: https://github.com/inveniosoftware/invenio-vcs/blob/master/LICENSE
+
+
+Invenio module that adds VCS integration to the platform.
+
+This module derives from the `Invenio GitHub`_ module, but is nearly fully rewritten and not
+backward compatible. Please refer to the upgrade guide to transition your instance to this
+new module.
+
+.. _Invenio GitHub: https://github.com/inveniosoftware/invenio-github
+
+*This is an experimental developer preview release.*
+
+* Free software: MIT license
+* Documentation: https://invenio-vcs.readthedocs.io/
+
+..
+    This file is part of Invenio-VCS.
+    Copyright (C) 2016-2026 CERN.
+    Copyright (C) 2024-2026 Graz University of Technology.
+
+    Invenio-VCS 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.0.1 (release 2026-04-01)
+
+- initial release

invenio_vcs-0.0.1/README.rst

@@ -0,0 +1,39 @@
+..
+    This file is part of Invenio-VCS.
+    Copyright (C) 2023-2026 CERN.
+
+    Invenio-VCS 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-VCS
+================
+
+.. image:: https://img.shields.io/travis/inveniosoftware/invenio-vcs.svg
+        :target: https://travis-ci.org/inveniosoftware/invenio-vcs
+
+.. image:: https://img.shields.io/coveralls/inveniosoftware/invenio-vcs.svg
+        :target: https://coveralls.io/r/inveniosoftware/invenio-vcs
+
+.. image:: https://img.shields.io/github/tag/inveniosoftware/invenio-vcs.svg
+        :target: https://github.com/inveniosoftware/invenio-vcs/releases
+
+.. image:: https://img.shields.io/pypi/dm/invenio-vcs.svg
+        :target: https://pypi.python.org/pypi/invenio-vcs
+
+.. image:: https://img.shields.io/github/license/inveniosoftware/invenio-vcs.svg
+        :target: https://github.com/inveniosoftware/invenio-vcs/blob/master/LICENSE
+
+
+Invenio module that adds VCS integration to the platform.
+
+This module derives from the `Invenio GitHub`_ module, but is nearly fully rewritten and not
+backward compatible. Please refer to the upgrade guide to transition your instance to this
+new module.
+
+.. _Invenio GitHub: https://github.com/inveniosoftware/invenio-github
+
+*This is an experimental developer preview release.*
+
+* Free software: MIT license
+* Documentation: https://invenio-vcs.readthedocs.io/

invenio_vcs-0.0.1/babel.ini

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2023-2026 CERN.
+#
+# Invenio-VCS is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+# Extraction from Python source files
+[python: **.py]
+encoding = utf-8
+
+# Extraction from Jinja2 templates
+[jinja2: **/templates/**.html]
+encoding = utf-8

invenio_vcs-0.0.1/constraints-pypi.txt

@@ -0,0 +1 @@
+# Empty on purpose

invenio_vcs-0.0.1/invenio_vcs/__init__.py

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2023-2026 CERN.
+# Copyright (C) 2024-2025 Graz University of Technology.
+#
+# Invenio-VCS 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 module that adds VCS integration to the platform."""
+
+from .ext import InvenioVCS
+
+__version__ = "0.0.1"
+
+__all__ = ("__version__", "InvenioVCS")

invenio_vcs-0.0.1/invenio_vcs/alembic/1754318294_switch_to_generic_git_services.py

@@ -0,0 +1,131 @@
+# -*- coding: utf-8 -*-
+# This file is part of Invenio.
+# Copyright (C) 2026 CERN.
+#
+# Invenio is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Switch to a generic VCS module (not GitHub-specific)."""
+
+import sqlalchemy as sa
+from alembic import op
+from invenio_db.shared import UTCDateTime
+from sqlalchemy_utils import JSONType, UUIDType
+
+# revision identifiers, used by Alembic.
+revision = "1754318294"
+down_revision = "6abc1c58775e"
+branch_labels = ()
+depends_on = None
+
+
+def upgrade():
+    """Upgrade database."""
+    op.create_table(
+        "vcs_repositories",
+        sa.Column("id", UUIDType()),
+        sa.Column("provider_id", sa.String(length=255), nullable=False),
+        sa.Column(
+            "provider", sa.String(length=255), nullable=False, server_default="github"
+        ),
+        sa.Column("name", sa.String(length=255), nullable=False),
+        sa.Column(
+            "default_branch",
+            sa.String(length=255),
+            nullable=False,
+            server_default="main",
+        ),
+        sa.Column("description", sa.String(length=10000)),
+        sa.Column("hook", sa.String(length=255)),
+        sa.Column("enabled_by_user_id", sa.Integer),
+        sa.Column("record_community_id", UUIDType(), nullable=True),
+        sa.Column("created", UTCDateTime(), nullable=False),
+        sa.Column("updated", UTCDateTime(), nullable=False),
+        sa.PrimaryKeyConstraint("id", name=op.f("pk_vcs_repositories")),
+        sa.ForeignKeyConstraint(
+            ["enabled_by_user_id"],
+            ["accounts_user.id"],
+            name=op.f("fk_vcs_repository_enabled_by_user_id_accounts_user"),
+        ),
+        sa.UniqueConstraint(
+            "provider",
+            "provider_id",
+            name=op.f("uq_vcs_repositories_provider_provider_id"),
+        ),
+    )
+
+    op.create_table(
+        "vcs_repository_users",
+        sa.Column("repository_id", UUIDType()),
+        sa.Column("user_id", sa.Integer()),
+        sa.Column("created", UTCDateTime(), nullable=False),
+        sa.Column("updated", UTCDateTime(), nullable=False),
+        sa.PrimaryKeyConstraint(
+            "repository_id", "user_id", name=op.f("pk_vcs_repository_users")
+        ),
+        sa.ForeignKeyConstraint(
+            ["repository_id"],
+            ["vcs_repositories.id"],
+            name=op.f("fk_vcs_repository_users_repository_id_vcs_repositories"),
+        ),
+        sa.ForeignKeyConstraint(
+            ["user_id"],
+            ["accounts_user.id"],
+            name=op.f("fk_vcs_repository_users_user_id_accounts_user"),
+        ),
+    )
+
+    op.create_table(
+        "vcs_releases",
+        sa.Column("id", UUIDType()),
+        sa.Column("provider_id", sa.String(length=255), nullable=False),
+        sa.Column(
+            "provider", sa.String(length=255), nullable=False, server_default="github"
+        ),
+        sa.Column("tag", sa.String(length=255), nullable=False),
+        sa.Column(
+            "errors",
+            sa.JSON()
+            .with_variant(sa.dialects.postgresql.JSONB(), "postgresql")
+            .with_variant(JSONType(), "sqlite")
+            .with_variant(JSONType(), "mysql"),
+        ),
+        sa.Column("repository_id", UUIDType(), nullable=False),
+        sa.Column("event_id", UUIDType(), nullable=True),
+        sa.Column("record_id", UUIDType(), nullable=True),
+        sa.Column(
+            "record_is_draft", sa.Boolean(), server_default="false", nullable=True
+        ),
+        sa.Column("status", sa.CHAR(1)),
+        sa.Column("created", UTCDateTime(), nullable=False),
+        sa.Column("updated", UTCDateTime(), nullable=False),
+        sa.PrimaryKeyConstraint("id", name=op.f("pk_vcs_releases")),
+        sa.ForeignKeyConstraint(
+            ["event_id"],
+            ["webhooks_events.id"],
+            name=op.f("fk_vcs_releases_event_id_webhooks_events"),
+        ),
+        sa.ForeignKeyConstraint(
+            ["repository_id"],
+            ["vcs_repositories.id"],
+            name=op.f("fk_vcs_releases_repository_id_vcs_repositories"),
+        ),
+        sa.UniqueConstraint(
+            "provider",
+            "provider_id",
+            name=op.f("uq_vcs_releases_provider_id_provider"),
+        ),
+    )
+
+    op.create_index(
+        op.f("ix_vcs_releases_record_id"),
+        table_name="vcs_releases",
+        columns=["record_id"],
+    )
+
+
+def downgrade():
+    """Downgrade database."""
+    op.drop_table("vcs_releases")
+    op.drop_table("vcs_repository_users")
+    op.drop_table("vcs_repositories")

invenio_vcs-0.0.1/invenio_vcs/alembic/6abc1c58775e_create_vcs_branch.py

@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+# This file is part of Invenio.
+# Copyright (C) 2026 CERN.
+#
+# Invenio is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""create vcs branch.
+
+Revision ID: 6abc1c58775e
+Revises:
+Create Date: 2026-02-03 14:31:10.367638
+
+"""
+
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "6abc1c58775e"
+down_revision: Union[str, Sequence[str], None] = None
+# We are creating a brand new branch invenio_vcs instead of continuing the existing invenio_github.
+# The new migrations do not assume anything about the existing tables and do not attempt to delete them.
+# Data must be migrated over manually or using the upgrade script.
+branch_labels: Union[str, Sequence[str], None] = ("invenio_vcs",)
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    """Upgrade schema."""
+    pass
+
+
+def downgrade() -> None:
+    """Downgrade schema."""
+    pass