Initial commit

.gitignore

+*~
+.coverage
+__pycache__
+.tox
+*.egg-info
+venv/
+build
\ No newline at end of file

CHANGELOG.md

+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased] ##
+
+### Added ###
+
+### Changed ###
+
+### Deprecated ###
+
+### Removed ###
+
+### Fixed ###
+
+### Security ###
+
+### Documentation ###

README.md

+# LinkAhead Python Package Template
+
+This Repo serves as a template for LinkAhead related Python packages, e.g.,
+custom crawler converters.
+
+## Usage
+
+To create a new Python package, fork this repo and change the names in the `src`
+directory, `pyproject.toml`, `setup.cfg`. Also edit the `authors` field
+therein. If applicable, create a `citation.cff` for the new project.
+
+Then, write your Python code in `/src/<package_name>`, and add unit tests in
+`unittests`. Documentation goes to `/src/doc`.

src/doc/index.rst

+LinkkAhead Python Package Template
+==================================
+
+**TODO**: Write your documentation here.

src/linkahead_python_package_template/__init__.py

+#
+# This file is a part of the LinkAhead Project.
+#
+# Copyright (C) 2024 IndiScale GmbH <info@indiscale.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <https://www.gnu.org/licenses/>.
+#

tox.ini

+[tox]
+envlist = py38, py39, py310, py311, py312, py313
+skip_missing_interpreters = true
+
+[testenv]
+deps = .
+commands =
+    py.test --cov=linkahead -vv {posargs}
+
+[flake8]
+max-line-length = 100
+
+[pycodestyle]
+max-line-length = 100
+
+[pytest]
+testpaths = unittests
+xfail_strict = True

unittests/test_template.py

+#
+# This file is a part of the LinkAhead Project.
+#
+# Copyright (C) 2024 IndiScale GmbH <info@indiscale.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <https://www.gnu.org/licenses/>.
+#
+
+def test_template():
+
+    assert True