Metadata-Version: 2.4
Name: zuul
Version: 14.3.0
Summary: A Project Gating System
Home-page: https://zuul-ci.org/
Author: Zuul Team
Author-email: zuul-discuss@lists.zuul-ci.org
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.11
License-File: LICENSE
License-File: COPYING
Requires-Dist: pbr>=1.1.0
Requires-Dist: virtualenv!=20.0.0,!=20.0.1,>20
Requires-Dist: python-dateutil
Requires-Dist: github3.py>=1.1.0
Requires-Dist: PyYAML>=5.1.0
Requires-Dist: paramiko>=2.0.1
Requires-Dist: GitPython>=2.1.8
Requires-Dist: python-daemon>=2.0.4
Requires-Dist: extras
Requires-Dist: statsd>=3.0
Requires-Dist: prometheus-client
Requires-Dist: voluptuous>=0.10.2
Requires-Dist: apscheduler>=3.0
Requires-Dist: tzlocal<3.0
Requires-Dist: PrettyTable
Requires-Dist: babel>=1.0
Requires-Dist: netaddr
Requires-Dist: kazoo
Requires-Dist: sqlalchemy<2.1.0,>=2.0.0
Requires-Dist: alembic
Requires-Dist: cryptography>=39.0.0
Requires-Dist: cachecontrol
Requires-Dist: cachetools
Requires-Dist: pyjwt>=2.5.0
Requires-Dist: psutil
Requires-Dist: google-re2>=1.1
Requires-Dist: paho-mqtt<2.0.0
Requires-Dist: cherrypy
Requires-Dist: ws4py
Requires-Dist: routes
Requires-Dist: jsonpath-rw
Requires-Dist: urllib3!=1.25.4,!=1.25.5
Requires-Dist: cheroot
Requires-Dist: elasticsearch<8.0.0
Requires-Dist: PyMySQL
Requires-Dist: psycopg2-binary
Requires-Dist: opentelemetry-sdk>=1.25.0
Requires-Dist: opentelemetry-exporter-otlp-proto-grpc>=1.25.0
Requires-Dist: opentelemetry-exporter-otlp-proto-http>=1.25.0
Requires-Dist: mmh3
Requires-Dist: confluent-kafka
Requires-Dist: google-api-core
Requires-Dist: google-cloud-pubsub
Requires-Dist: openstacksdk!=2.0.0,>=0.103.0
Requires-Dist: rackspaceauth
Requires-Dist: openshift
Requires-Dist: boto3>=1.42.48
Provides-Extra: zuul-base
Requires-Dist: yappi; extra == "zuul-base"
Requires-Dist: objgraph; extra == "zuul-base"
Requires-Dist: python-logstash-async; extra == "zuul-base"
Provides-Extra: test
Requires-Dist: coverage>=3.6; extra == "test"
Requires-Dist: fixtures>=0.3.14; extra == "test"
Requires-Dist: stestr>=1.0.0; extra == "test"
Requires-Dist: testtools>=0.9.32; extra == "test"
Requires-Dist: graphql-core<=3.2.6; extra == "test"
Requires-Dist: PyMySQL; extra == "test"
Requires-Dist: psycopg2-binary; extra == "test"
Requires-Dist: beautifulsoup4; extra == "test"
Requires-Dist: graphene; extra == "test"
Requires-Dist: requests_mock; extra == "test"
Requires-Dist: moto; extra == "test"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

Zuul
====

Zuul is a project gating system.

The latest documentation for the current version of Zuul is published at:
https://zuul-ci.org/docs/zuul/

If you are looking for the Edge routing service named Zuul that is
related to Netflix, it can be found here:
https://github.com/Netflix/zuul

If you are looking for the Javascript testing tool named Zuul, its
archive can be found here:
https://github.com/defunctzombie/zuul

Getting Help
------------

There are two Zuul-related mailing lists:

`zuul-announce <http://lists.zuul-ci.org/cgi-bin/mailman/listinfo/zuul-announce>`_
  A low-traffic announcement-only list to which every Zuul operator or
  power-user should subscribe.

`zuul-discuss <http://lists.zuul-ci.org/cgi-bin/mailman/listinfo/zuul-discuss>`_
  General discussion about Zuul, including questions about how to use
  it, and future development.

You will also find Zuul developers on
`Matrix <https://matrix.to/#/#zuul:opendev.org>`.

Contributing
------------

To browse the latest code, see: https://opendev.org/zuul/zuul
To clone the latest code, use `git clone https://opendev.org/zuul/zuul`

Bugs are handled at: https://storyboard.openstack.org/#!/project/zuul/zuul

Suspected security vulnerabilities are most appreciated if first
reported privately following any of the supported mechanisms
described at https://zuul-ci.org/docs/zuul/latest/vulnerabilities.html

Code reviews are handled by gerrit at https://review.opendev.org

After creating a Gerrit account, use `git review` to submit patches.
Example::

    # Do your commits
    $ git review
    # Enter your username if prompted

`Join us on Matrix <https://matrix.to/#/#zuul:opendev.org>`_ to discuss
development or usage.

AI-Generated Content
--------------------

In general, please do not submit AI generated content to the Zuul
project, but some exceptions apply.

The OpenInfra foundation has created a policy for AI Generated content
at https://openinfra.org/legal/ai-policy which provides useful
background to the Zuul project's policy, but the Zuul project policy
differs somewhat.

As a free software project, we are concerned with the copyright
ownership of the project's source code.  Because most commercially
available LLMs are not able to indicate whether their output may
include training data incompatible with Zuul's licences, accepting
substantial contributions generated by them increases the risk to the
project.  And because LLM-generated output is not considered
copyrightable in the United States and other regions, that further
increases the risk to the project.

In many cases, the code and documentation output from LLMs is not of
sufficient quality for easy incorporation into Zuul.  A community of
contributors and reviewers with deep understanding of the project is
healthier in the long run.  Contributions generated by LLMs without
that understanding creates more work for the maintainers.

Nevertheless, if you use an LLM to create a very small patch (one that
would likely not be subject to copyright protection even if generated
by a human), that's fine, but you must annotate it with the
`Assisted-By` or `Generated-By` labels.

In short:

* Please do not submit substantial AI-generated content (code or docs)
* Very small/limited use may be okay if it's not copyrightable
* Make sure you fully understand the code or docs you are changing
* If you don't, engage with humans in the Zuul community
* Any AI-Generated content must have `Assisted-By` or `Generated-By` labels

License
-------

Zuul is free software.  Most of Zuul is licensed under the Apache
License, version 2.0.  Some parts of Zuul are licensed under the
General Public License, version 3.0.  Please see the license headers
at the tops of individual source files.

Python Version Support
----------------------

Zuul requires Python 3. It does not support Python 2.

Since Zuul uses Ansible to drive CI jobs, Zuul can run tests anywhere
Ansible can, including Python 2 environments.

