https://github.com/python/blurb_it

`blurb add` over the internet
https://github.com/python/blurb_it

Last synced: 3 months ago
JSON representation

`blurb add` over the internet

• Host: GitHub
• URL: https://github.com/python/blurb_it
• Owner: python
• License: apache-2.0
• Created: 2018-09-12T00:53:09.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-10-01T05:18:37.000Z (about 1 year ago)
• Last Synced: 2024-10-29T16:04:18.431Z (about 1 year ago)
• Language: Python
• Homepage: https://blurb-it.herokuapp.com/
• Size: 776 KB
• Stars: 27
• Watchers: 35
• Forks: 19
• Open Issues: 8
• Metadata Files:
  • Readme: readme.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
blurb_it

--------

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :target: https://github.com/psf/black

.. image:: https://github.com/python/blurb_it/actions/workflows/ci.yml/badge.svg?event=push

    :target: https://github.com/python/blurb_it/actions

.. image:: https://codecov.io/gh/python/blurb_it/branch/main/graph/badge.svg

    :target: https://codecov.io/gh/python/blurb_it

``blurb add`` over the internet.

About

=====

📜🤖 blurb-it allows you to add a misc/news file to your own

`CPython `_ pull request.

A ``Misc/NEWS.d`` file `is needed

`_

for almost all non-trivial changes to CPython.

To use blurb-it, you must be logged in to GitHub.

Install blurb-it GitHub App to your account, and then grant the ``write`` access to your

fork of the CPython repository.

Since blurb-it will have write access to the granted repo, you should only install

it on your own CPython repository.

`Install blurb-it `_ .

Uninstall blurb-it

==================

1. Go to https://github.com/settings/installations.

2. Click blurb-it's "Configure" button.

3. Scroll down and click the "Uninstall" button.

Deploy

======

|Deploy|

.. |Deploy| image:: https://www.herokucdn.com/deploy/button.svg

   :target: https://heroku.com/deploy?template=https://github.com/python/blurb_it

Requirements and dependencies

=============================

- Python 3.9+

- aiohttp

- aiohttp-jinja2

- gidgethub >= 5.0.0

- pyjwt >= 2.0.0

- cryptography

Running tests

=============

1. Create a Python virtual environment with ``$ python3 -m venv venv``

2. Activate the virtual environment with ``$ . venv/bin/activate``

3. Install dev requirements with ``(venv)$ pip install -r dev-requirements.txt``

4. Run all tests with ``(venv)$ pytest tests``