zope.meta 1.0__tar.gz

zope_meta-1.0/.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+# Generated from:
+# https://github.com/zopefoundation/meta/tree/master/config/pure-python
+minimum_pre_commit_version: '3.6'
+repos:
+  - repo: https://github.com/pycqa/isort
+    rev: "5.13.2"
+    hooks:
+    - id: isort
+  - repo: https://github.com/hhatto/autopep8
+    rev: "v2.3.1"
+    hooks:
+    - id: autopep8
+      args: [--in-place, --aggressive, --aggressive]
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.17.0
+    hooks:
+    - id: pyupgrade
+      args: [--py38-plus]
+  - repo: https://github.com/isidentical/teyit
+    rev: 0.4.3
+    hooks:
+    - id: teyit
+  - repo: https://github.com/PyCQA/flake8
+    rev: "7.1.1"
+    hooks:
+    - id: flake8
+      additional_dependencies:
+        - flake8-debugger == 4.1.2

zope_meta-1.0/.readthedocs.yaml

@@ -0,0 +1,25 @@
+# Generated from:
+# https://github.com/zopefoundation/meta/tree/master/config/pure-python
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+  - requirements: docs/requirements.txt
+  - method: pip
+    path: .

zope_meta-1.0/CHANGES.rst

@@ -0,0 +1,7 @@
+Change log
+==========
+
+1.0 (2024-10-02)
+----------------
+
+- Converted to an installable Python package.

zope_meta-1.0/CONTRIBUTING.md

@@ -0,0 +1,23 @@
+<!--
+Generated from:
+https://github.com/zopefoundation/meta/tree/master/config/pure-python
+--> 
+# Contributing to zopefoundation projects
+
+The projects under the zopefoundation GitHub organization are open source and
+welcome contributions in different forms:
+
+* bug reports
+* code improvements and bug fixes
+* documentation improvements
+* pull request reviews
+
+For any changes in the repository besides trivial typo fixes you are required
+to sign the contributor agreement. See
+https://www.zope.dev/developer/becoming-a-committer.html for details.
+
+Please visit our [Developer
+Guidelines](https://www.zope.dev/developer/guidelines.html) if you'd like to
+contribute code changes and our [guidelines for reporting
+bugs](https://www.zope.dev/developer/reporting-bugs.html) if you want to file a
+bug report.

zope_meta-1.0/COPYRIGHT.txt

@@ -0,0 +1 @@
+Zope Foundation and Contributors

zope_meta-1.0/LICENSE.txt

@@ -0,0 +1,44 @@
+Zope Public License (ZPL) Version 2.1
+
+A copyright notice accompanies this license document that identifies the
+copyright holders.
+
+This license has been certified as open source. It has also been designated as
+GPL compatible by the Free Software Foundation (FSF).
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions in source code must retain the accompanying copyright
+notice, this list of conditions, and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the accompanying copyright
+notice, this list of conditions, and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+3. Names of the copyright holders must not be used to endorse or promote
+products derived from this software without prior written permission from the
+copyright holders.
+
+4. The right to distribute this software or to use it for any purpose does not
+give you the right to use Servicemarks (sm) or Trademarks (tm) of the
+copyright
+holders. Use of them is covered by separate agreement with the copyright
+holders.
+
+5. If any files are modified, you must cause the modified files to carry
+prominent notices stating that you changed the files and the date of any
+change.
+
+Disclaimer
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY EXPRESSED
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

zope_meta-1.0/MANIFEST.in

@@ -0,0 +1,21 @@
+# Generated from:
+# https://github.com/zopefoundation/meta/tree/master/config/pure-python
+include *.md
+include *.rst
+include *.txt
+include buildout.cfg
+include tox.ini
+include .pre-commit-config.yaml
+
+recursive-include docs *.py
+recursive-include docs *.rst
+recursive-include docs *.txt
+recursive-include docs Makefile
+
+recursive-include src *.py
+include *.yaml
+recursive-include docs *.bat
+recursive-include src *.j2
+recursive-include src *.md
+recursive-include src *.sh
+recursive-include src *.txt

zope_meta-1.0/PKG-INFO

@@ -0,0 +1,75 @@
+Metadata-Version: 2.1
+Name: zope.meta
+Version: 1.0
+Summary: Helper functions for package management
+Home-page: https://github.com/zopefoundation/meta
+Author: Zope Foundation and Contributors
+Author-email: zope-dev@zope.dev
+License: ZPL 2.1
+Project-URL: Documentation, https://zopemeta.readthedocs.io
+Project-URL: Issue Tracker, https://github.com/zopefoundation/meta/issues
+Project-URL: Sources, https://github.com/zopefoundation/meta
+Keywords: zope packaging
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Zope Public License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+Requires-Dist: setuptools
+Requires-Dist: check-python-versions
+Requires-Dist: Jinja2
+Requires-Dist: packaging
+Requires-Dist: pyupgrade
+Requires-Dist: requests
+Requires-Dist: tomlkit
+Requires-Dist: tox
+Requires-Dist: zest.releaser
+Provides-Extra: test
+Requires-Dist: zope.testrunner; extra == "test"
+Provides-Extra: docs
+Requires-Dist: Sphinx; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+
+``zope.meta``
+=============
+
+.. image:: https://img.shields.io/pypi/v/zope.meta.svg
+    :target: https://pypi.python.org/pypi/zope.meta/
+    :alt: Latest Version
+
+.. image:: https://github.com/zopefoundation/meta/actions/workflows/tests.yml/badge.svg
+    :target: https://github.com/zopefoundation/meta/actions/workflows/tests.yml
+
+.. image:: https://coveralls.io/repos/github/zopefoundation/meta/badge.svg?branch=master
+    :target: https://coveralls.io/github/zopefoundation/meta?branch=master
+        
+.. image:: https://readthedocs.org/projects/zopemeta/badge/?version=latest
+    :target: https://zopemeta.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+This package contains helper functions and scripts for maintaining package
+configurations for Zope Foundation GitHub packages
+(https://github.com/zopefoundation).
+
+Please visit https://zopemeta.readthedocs.io for the documentation.
+
+
+Change log
+==========
+
+1.0 (2024-10-02)
+----------------
+
+- Converted to an installable Python package.

zope_meta-1.0/README.rst

@@ -0,0 +1,22 @@
+``zope.meta``
+=============
+
+.. image:: https://img.shields.io/pypi/v/zope.meta.svg
+    :target: https://pypi.python.org/pypi/zope.meta/
+    :alt: Latest Version
+
+.. image:: https://github.com/zopefoundation/meta/actions/workflows/tests.yml/badge.svg
+    :target: https://github.com/zopefoundation/meta/actions/workflows/tests.yml
+
+.. image:: https://coveralls.io/repos/github/zopefoundation/meta/badge.svg?branch=master
+    :target: https://coveralls.io/github/zopefoundation/meta?branch=master
+        
+.. image:: https://readthedocs.org/projects/zopemeta/badge/?version=latest
+    :target: https://zopemeta.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+This package contains helper functions and scripts for maintaining package
+configurations for Zope Foundation GitHub packages
+(https://github.com/zopefoundation).
+
+Please visit https://zopemeta.readthedocs.io for the documentation.

zope_meta-1.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

zope_meta-1.0/docs/_build/html/_sources/api.rst.txt

@@ -0,0 +1,2 @@
+:mod:`zope.meta` API Reference
+==============================

zope_meta-1.0/docs/_build/html/_sources/hacking.rst.txt

@@ -0,0 +1,192 @@
+Hacking on :mod:`zope.meta`
+===========================
+
+
+Getting the Code
+################
+
+The main repository for :mod:`zope.meta` is in the Zope Foundation
+Github repository:
+
+  https://github.com/zopefoundation/meta
+
+You can get a read-only checkout from there:
+
+.. code-block:: sh
+
+   $ git clone https://github.com/zopefoundation/meta.git
+
+or fork it and get a writeable checkout of your fork:
+
+.. code-block:: sh
+
+   $ git clone git@github.com/jrandom/meta.git
+
+
+Working in a Python virtual environment
+#######################################
+
+Installing
+----------
+
+You can use Python's standard ``venv`` package to create lightweight Python
+development environments, where you can run the tests using nothing more
+than the ``python`` binary in a virtualenv.  First, create a scratch
+environment:
+
+.. code-block:: sh
+
+   $ python3.12 -m venv /tmp/hack-zope.meta
+
+Next, install this package in "development mod" in the newly-created
+environment:
+
+.. code-block:: sh
+
+   $ /tmp/hack-zope.meta/bin/pip install -e .
+
+Running the tests
+-----------------
+
+You can install test tools using the ``test`` extra:
+
+.. code-block:: sh
+
+   $ /tmp/hack-zope.meta/bin/pip install -e ".[test]"
+
+
+That command installs the tools needed to run
+the tests:  in particular, the ``zope.testrunner`` (see
+:external+testrunner:std:doc:`getting-started`) and
+:external+coverage:std:doc:`index` tools.
+
+To run the tests via ``zope.testrunner``:
+
+.. code-block:: sh
+
+   $ /tmp/hack-zope.meta/bin/zope-testrunner --test-path=src
+   Running zope.testrunner.layer.UnitTests tests:
+   ...
+
+Running the tests under :mod:`coverage` lets you see how well the tests
+cover the code:
+
+.. code-block:: sh
+
+   $ /tmp/hack-zope.meta/bin/coverage run -m zope.testrunner \
+      --test-path=src
+   ...
+   $ coverage report -i -m --fail-under=100
+   Name                                 Stmts   Miss Branch BrPart    Cover   Missing
+   ----------------------------------------------------------------------------------
+   ...
+
+
+Building the documentation
+--------------------------
+
+:mod:`zope.meta` uses the nifty :mod:`Sphinx` documentation system
+for building its docs.  Using the same virtualenv you set up to run the
+tests, you can build the docs:
+
+The ``docs`` command alias downloads and installs Sphinx and its dependencies:
+
+.. code-block:: sh
+
+   $ /tmp/hack-zope.meta/bin/pip install ".[docs]"
+   ...
+   $ /tmp/hack-zope.meta/bin/sphinx-build -b html -d docs/_build/doctrees docs docs/_build/html
+   ...
+   build succeeded.
+
+   The HTML pages are in docs/_build/html.
+
+
+Using :mod:`tox`
+################
+
+
+Running Tests on Multiple Python Versions
+-----------------------------------------
+
+`tox <http://tox.testrun.org/latest/>`_ is a Python-based test automation
+tool designed to run tests against multiple Python versions.  It creates
+a virtual environment for each configured version, installs the current
+package and configured dependencies into each environment, and then runs the
+configured commands.
+   
+:mod:`zope.meta` configures the following :mod:`tox` environments via
+its ``tox.ini`` file:
+
+- The ``lint`` environment runs various "code quality" tests on the source,
+  and fails on any errors they find.
+
+- The ``pyXX`` and ``pypy3`` environments each build an environment from the
+  corresponding
+  Python version, install :mod:`zope.meta` and testing dependencies,
+  and runs the tests.  It then installs ``Sphinx`` and runs the doctest
+  snippets.
+
+- The ``coverage`` environment builds a virtual environment,
+  installs :mod:`zope.meta` and dependencies, installs
+  :mod:`coverage`, and runs the tests with statement and branch
+  coverage.
+
+- The ``docs`` environment builds a virtual environment, installs
+  :mod:`zope.meta` and dependencies, installs ``Sphinx`` and
+  dependencies, and then builds the docs and exercises the doctest snippets.
+
+This example requires that you have a working ``python3.12`` on your path,
+as well as installing ``tox``:
+
+.. code-block:: sh
+
+   $ tox -e py312
+   py312: install_deps> python -I -m pip install 'setuptools<74' Sphinx
+   ...
+   py312: commands[0]> zope-testrunner --test-path=src -vc
+   Running tests at level 1
+   Running zope.testrunner.layer.UnitTests tests:
+     Set up zope.testrunner.layer.UnitTests in 0.000 seconds.
+     Running:
+   .....
+
+Running ``tox`` with no arguments runs all the configured environments,
+including building the docs and testing their snippets.
+
+
+Contributing to :mod:`zope.meta`
+################################
+
+Submitting a Bug Report
+-----------------------
+
+:mod:`zope.meta` tracks its bugs on Github:
+
+  https://github.com/zopefoundation/meta/issues
+
+Please submit bug reports and feature requests there.
+
+Sharing Your Changes
+--------------------
+
+.. note::
+
+   Please ensure that all tests are passing before you submit your code.
+   If possible, your submission should include new tests for new features
+   or bug fixes, although it is possible that you may have tested your
+   new code by updating existing tests.
+
+   Contributions to Plone/Zope Foundation packages require contributor status.
+   Please see https://www.zope.dev/developer/becoming-a-committer.html.
+
+If you have made changes you would like to share, the best route is to create a
+branch in the GitHub repository and push changes there, which requires
+`contributor status 
+<https://www.zope.dev/developer/becoming-a-committer.html>`_. You can
+also fork the GitHub repository, check out your fork, make your changes on a
+branch in your fork, and then push them. A private fork makes it harder for
+others and the package maintainers to work with your changes, so it is
+discouraged. Either way, you can then submit a pull request from your branch:
+
+  https://github.com/zopefoundation/meta/pulls

zope_meta-1.0/docs/_build/html/_sources/index.rst.txt

@@ -0,0 +1,24 @@
+:mod:`zope.meta` Documentation
+==============================
+
+This package provides helper functions and scripts to maintain package
+configurations for the Zope Foundation packages.
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   narr
+   api
+   hacking
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+