Skip to content

Commit 13585ff

Browse files
author
Irving Popovetsky
committed
readme updates
1 parent 2ba7840 commit 13585ff

File tree

1 file changed

+12
-19
lines changed

1 file changed

+12
-19
lines changed

README.md

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,17 @@
11
<div align="center">
2-
<a href="https://operationcode.org" height="750" width="750">
2+
<a href="https://operationcode.org">
33
<img
4-
alt="Operation Code Hacktoberfest Banner"
5-
src="https://operation-code-assets.s3.us-east-2.amazonaws.com/operationcode_hacktoberfest_2020.jpg"
4+
alt="Operation Code Logo"
5+
src="https://operation-code-assets.s3.us-east-2.amazonaws.com/branding/logos/large-blue-logo.png"
6+
width="400"
67
>
78
</a>
89
</div>
9-
<br />
10-
<br />
11-
12-
1310
<br />
1411

1512
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
16-
[![Twitter Follow](https://img.shields.io/twitter/follow/operation_code.svg?style=social&label=Follow&style=social)](https://twitter.com/operation_code)
17-
[![Code-style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
18-
19-
20-
[![CircleCI](https://circleci.com/gh/OperationCode/operationcode-pybot.svg?style=svg)](https://circleci.com/gh/OperationCode/operationcode-pybot)
21-
[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=OperationCode/operationcode-pybot)](https://dependabot.com)
13+
[![CI](https://github.com/OperationCode/operationcode-pybot/actions/workflows/ci.yml/badge.svg)](https://github.com/OperationCode/operationcode-pybot/actions/workflows/ci.yml)
14+
[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
2215
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://contributor-covenant.org/)
2316

2417
# [OperationCode-Pybot](https://github.com/OperationCode/operationcode-pybot)
@@ -41,7 +34,7 @@ The vendored code has been modernized with:
4134
- Removed deprecated `asyncio.coroutine()` usage
4235
- Fixed deprecated `loop=` parameter patterns
4336
- Replaced removed `cgi` module with `email.message`
44-
- Added Python 3.12 type hints
37+
- Added Python 3.12+ type hints
4538

4639
## Resources
4740
* [Slack Bot Tutorial](https://www.digitalocean.com/community/tutorials/how-to-build-a-slackbot-in-python-on-ubuntu-20-04)
@@ -54,9 +47,9 @@ Bug reports and pull requests are welcome on [Github](https://github.com/Operati
5447

5548
## Quick Start
5649
Recommended versions of tools used within the repo:
57-
- `python@3.12` or greater (Python 3.13+ also supported)
50+
- `python@3.14` or greater
5851
- `git@2.17.1` or greater
59-
- `poetry@1.0` or greater
52+
- `poetry@2.0` or greater
6053
- [Poetry](https://python-poetry.org/) is a packaging and dependency manager, similar to pip or pipenv
6154
- Install via: `curl -sSL https://install.python-poetry.org | python3 -`
6255
- See https://python-poetry.org/docs/
@@ -73,7 +66,7 @@ poetry run python -m pybot
7366
poetry run pytest
7467

7568
# Run formatting and linting
76-
poetry run black pybot/ tests/
69+
poetry run ruff format pybot/ tests/
7770
poetry run ruff check pybot/ tests/
7871
```
7972

@@ -253,7 +246,7 @@ Command | Description | Usage Hint
253246
/ticket | submit ticket to admins | (text of ticket)
254247

255248

256-
**👋 IMPORTANT!**
249+
**IMPORTANT!**
257250

258251
The `/lunch` command requires a valid Yelp API token stored in the `YELP_TOKEN`
259252
environment variable. See https://www.yelp.com/developers/faq
@@ -264,7 +257,7 @@ functionality please reach out to the `#oc-python-projects` channel for help get
264257

265258
### Airtable Authentication
266259

267-
**⚠️ IMPORTANT:** Airtable deprecated API keys on February 1, 2024. You must use a **Personal Access Token (PAT)**:
260+
**IMPORTANT:** Airtable deprecated API keys on February 1, 2024. You must use a **Personal Access Token (PAT)**:
268261

269262
1. Go to [Airtable Developer Hub](https://airtable.com/create/tokens)
270263
2. Click **Create new token**

0 commit comments

Comments
 (0)