the-knights-who-say-ni - GitLite

KO | EN

gitlite — search

#postgresql #agent #llm #docker #go #mysql #github #shell #data-science #large-language-models

the-knights-who-say-ni

(★ 86)

CLA enforcement bot for Python organization projects

File Explorer

ZIP Download

- - ci.yml
- dependabot.yml
- - __init__.py
  - test_bpo.py
  - test_github.py
  - test_heroku.py
  - test_main.py
  - util.py
- __init__.py
- __main__.py
- abc.py
- bpo.py
- github.py
- heroku.py
.coveragerc
.gitignore
app.json
CONTRIBUTING.md
LICENSE
mypy.ini
Procfile
README.md
requirements.in
requirements.txt
runtime.txt
test.bat
test.sh

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

`write`

View Details ▼

Write data to memory.

write memory

Write current configuration to memory:

write {{username}} {{terminal_id}}

Send a message to a given user on a given terminal ID:

write {{username}} {{terminal_id}}

Send a message to a given user on a given terminal ID:

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

> **NOTE**: This project is no longer used by https://github.com/python/
> and as such is no longer being maintained.
>
> The current CLA bot infrastructure is based on
> [edgedb/cla-bot](https://github.com/edgedb/cla-bot/)
> and lives at [apps/cpython-cla-bot](https://github.com/apps/cpython-cla-bot#-who-says-ekke-ekke-ekke-ekke-ptang-zoom-boing).
> See [the discussion](https://discuss.python.org/t/14961) for more details.
>
> What follows is the original README with potentially outdated information.

---

A bot to check if the author of a pull request to a
[Python project](https://github.com/python) has signed the
[PSF CLA](https://www.python.org/psf/contrib/contrib-form/).

## Why is this project necessary?
A CLA is necessary to make sure that someone contributing to an
open source project legally promises that they are only giving code
to the project which they have the right to give. This means that there
are no copyrights on the code which prohibits contributing it, nor are
there patents making the use of the code illegal. This is really
important for open source projects like Python where the non-profit
behind the organization -- the
[Python Software Foundation](https://www.python.org/psf-landing/) in
Python's case -- do not have the money to pay for a patent license if a
mistake is made and patented code is contributed. Basically a CLA
means the Python project has some legal ground to stand on when it says
it didn't mean to use any code it wasn't meant to have.

But beyond just making sure the PSF is in the legal clear if bad code
is given to the Python project, it also helps make sure others who
use code from the Python project are also in the clear. If a company
wants to use Python code in a commercial fashion, having the Python
project's code covered by CLAs means they don't have to worry about
being sued as well.

## Design goals
A CLA bot breaks down into essentially three components:

1. The server host
2. The contribution host
3. The CLA records host

In the case of the Python project and this bot, the server host is
[Heroku](https://www.heroku.com/), the contribution host is
[GitHub](https://github.com), and the CLA records host is
[bugs.python.org](https://bugs.python.org/) (which is an installation
of [Roundup](http://roundup.sourceforge.net/)). But considering the
Python project was started back in 1990 and has already changed
contribution hosts at least three times, a design goal of this
project is to try and
**abstract the hosting platforms** so that when the next change to
the Python project's relevant hosting platform occurs it will not
require a full rewrite of this project to get CLA enforcement
working again.

Lastly, the master branch of this project will always strive to be
**stable and properly tested**. Because there are legal
ramifications if this project is unable to perform its duties, it is
imperative that it always function properly.

### Why wasn't some pre-existing CLA bot used?
There are several other CLA enforcement projects and services
available, such as [clabot](https://github.com/clabot/clabot),
[CLA Enforcer](https://github.com/datastax/cla-enforcer),
[CLAHub](https://github.com/clahub/clahub), and
[CLA Assistant](https://cla-assistant.io/). The issue with all of
these project is that they are either unmaintained or they make
assumptions about where/how CLAs are stored (e.g., they require
using [DocuSign](https://www.docusign.ca/)). Because of these issues
and the fact that this is an important project for Python itself, it
was deemed necessary to create our own CLA enforcement bot which the
Python project controlled and was able to make sure was maintained.

### Is this project useful to anyone besides the Python project?
While this project is, strictly speaking, geared towards the needs of
the Python project, the abstraction design goal should make it
relatively straight-forward to fork this project and to modify it as
necessary for your own needs.

## About the project's name
['The Knights Who Say "Ni!"'](https://www.youtube.com/watch?v=zIV4poUZAQo)
is a sketch from the film,
[Monty Python and the Holy Grail](https://en.wikipedia.org/wiki/Monty_Python_and_the_Holy_Grail).
The knights prevent travelers from passing through their forest
without a sacrifice (in the case of the film, they demand a
shrubbery). Since Python is actually named after Monty Python, it
seemed fitting to have the project named after something originating
from Monty Python relating to someone preventing something from
occurring without being given something (in the film it's the knights
requiring a shrubbery, in real life it's lawyers requiring a signed
CLA).

## Trusted Users List
Users in the Trusted Users List will not be checked for CLA.  This can be
useful if the user is a bot or an app.

## Deployment
### Running on Heroku

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/python/the-knights-who-say-ni)

1. Create Heroku project
2. Set the `GH_AUTH_TOKEN` environment variable to the GitHub oauth
   token to be used by the bot
3. Set up the Heroku project to get the code for the bot
4. Trusted users can be added to the `CLA_TRUSTED_USERS` environment variable
   as comma-separated list.
5. Create the `SENTRY_DSN` environment variable.

### Adding to a GitHub repository (Python-specific instructions)
1. Add the appropriate labels (`CLA signed` and `CLA not signed`)
2. Add the `PSF CLA enforcement` team to the project with `write` privileges
3. Add the webhook
    1. Add the URL
    2. Send `application/json` (the default)
    3. Add the secret
    4. Specify events to be `pull request` only (default is `push` which is unnecessary)