diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..ccd6e65 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,37 @@ +# Ignore the Docker files themselves to avoid that all layers are invalidated if the Dockerfiles are changed during development. +.dockerignore +Dockerfile +docker.env +docker-compose.yml + + +# Ignore Git directory and files and github directory. +**/.gitignore +**/.gitattributes +**/.gitmodules +**/.github + + +# Ignore IDE artifacts and various common tools .dot files +**/.vscode +**/.idea +**/.ssh +**/.DS_Store + + +# Ignore etc, docs and build dirs +**/docs +**/dist +**/build +**/etc +.readthedocs.yaml +CHANGELOG.rst +README.rst + + +# Ignore virtualenv and local Python build files +**/venv +**/*.egg-info + +# Ignore tests +**/tests \ No newline at end of file diff --git a/CHANGELOG.rst b/CHANGELOG.rst index fc2b6e3..60367f1 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,7 +2,7 @@ Changelog ========= -v0.0.0 +v0.1.0 ------ -*xxxx-xx-xx* -- Initial release. +- Initial release diff --git a/README.rst b/README.rst deleted file mode 100644 index 11a4dfb..0000000 --- a/README.rst +++ /dev/null @@ -1,107 +0,0 @@ -A Simple Python Project Skeleton -================================ - -This repo attempts to standardize the structure of the Python-based project's -repositories using modern Python packaging and configuration techniques. -Using this `blog post`_ as inspiration, this repository serves as the base for -all new Python projects and is mergeable in existing repositories as well. - -.. _blog post: https://blog.jaraco.com/a-project-skeleton-for-python-projects/ - - -Usage -===== - -A brand new project -------------------- - -.. code-block:: bash - - git init my-new-repo - cd my-new-repo - git pull git@github.com:nexB/skeleton - - # Create the new repo on GitHub, then update your remote - git remote set-url origin git@github.com:nexB/your-new-repo.git - -From here, you can make the appropriate changes to the files for your specific project. - -Update an existing project ---------------------------- - -.. code-block:: bash - - cd my-existing-project - git remote add skeleton git@github.com:nexB/skeleton - git fetch skeleton - git merge skeleton/main --allow-unrelated-histories - -This is also the workflow to use when updating the skeleton files in any given repository. - -More usage instructions can be found in ``docs/skeleton-usage.rst``. - - -Release Notes -============= - -- 2025-03-31: - - - Use ruff as the main code formatting tool, add ruff rules to pyproject.toml - -- 2025-03-29: - - - Add support for beta macOS-15 - - Add support for beta windows-2025 - -- 2025-02-14: - - - Drop support for Python 3.8, add support in CI for Python 3.13, use Python 3.12 as default - version. - -- 2025-01-17: - - - Drop support for macOS-12, add support for macOS-14 - - Add support in CI for ubuntu-24.04 - - Add support in CI for Python 3.12 - -- 2024-08-20: - - - Update references of ownership from nexB to aboutcode-org - -- 2024-07-01: - - - Drop support for Python 3.8 - - Drop support for macOS-11, add support for macOS-14 - -- 2024-02-19: - - - Replace support in CI of default ubuntu-20.04 by ubuntu-22.04 - -- 2023-10-18: - - - Add dark mode support in documentation - -- 2023-07-18: - - - Add macOS-13 job in azure-pipelines.yml - -- 2022-03-04: - - - Synchronize configure and configure.bat scripts for sanity - - Update CI operating system support with latest Azure OS images - - Streamline utility scripts in etc/scripts/ to create, fetch and manage third-party - dependencies. There are now fewer scripts. See etc/scripts/README.rst for details - -- 2021-09-03: - - ``configure`` now requires pinned dependencies via the use of ``requirements.txt`` - and ``requirements-dev.txt`` - - ``configure`` can now accept multiple options at once - - Add utility scripts from scancode-toolkit/etc/release/ for use in generating project files - - Rename virtual environment directory from ``tmp`` to ``venv`` - - Update README.rst with instructions for generating ``requirements.txt`` - and ``requirements-dev.txt``, as well as collecting dependencies as wheels and generating - ABOUT files for them. - -- 2021-05-11: - - Adopt new configure scripts from ScanCode TK that allows correct configuration of which - Python version is used. diff --git a/pyproject.toml b/pyproject.toml index 9b3b260..9e9e1db 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,7 +1,7 @@ [tool.poetry] -name = "grimoirelab-metrics" +name = "healthycode" version = "0.1.0" -description = "" +description = "Client to generate GrimoireLab metrics for Project Health using the software analytics platform GrimoireLab" authors = [ "Bitergia Developers", "AboutCode" diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index a0f2985..0000000 --- a/setup.cfg +++ /dev/null @@ -1,62 +0,0 @@ -[metadata] -name = skeleton -license = Apache-2.0 - -# description must be on ONE line https://github.com/pypa/setuptools/issues/1390 -description = skeleton -long_description = file:README.rst -long_description_content_type = text/x-rst -url = https://github.com/aboutcode-org/skeleton - -author = nexB. Inc. and others -author_email = info@aboutcode.org - -classifiers = - Development Status :: 5 - Production/Stable - Intended Audience :: Developers - Programming Language :: Python :: 3 - Programming Language :: Python :: 3 :: Only - Topic :: Software Development - Topic :: Utilities - -keywords = - utilities - -license_files = - apache-2.0.LICENSE - NOTICE - AUTHORS.rst - CHANGELOG.rst - CODE_OF_CONDUCT.rst - README.rst - -[options] -python_requires = >=3.10 - -package_dir = - =src -packages = find: -include_package_data = true -zip_safe = false - -install_requires = - - -[options.packages.find] -where = src - - -[options.extras_require] -dev = - pytest >= 7.0.1 - pytest-xdist >= 2 - aboutcode-toolkit >= 7.0.2 - twine - ruff - Sphinx>=5.0.2 - sphinx-rtd-theme>=1.0.0 - sphinx-reredirects >= 0.1.2 - doc8>=0.11.2 - sphinx-autobuild - sphinx-rtd-dark-mode>=1.3.0 - sphinx-copybutton diff --git a/setup.py b/setup.py deleted file mode 100644 index bac24a4..0000000 --- a/setup.py +++ /dev/null @@ -1,6 +0,0 @@ -#!/usr/bin/env python - -import setuptools - -if __name__ == "__main__": - setuptools.setup()