Skip to content

Commit f37e7cd

Browse files
refactor: reset to fbea999
- remove poetry - add uv - format md
1 parent f9ee865 commit f37e7cd

File tree

5 files changed

+218
-2907
lines changed

5 files changed

+218
-2907
lines changed

.tool-versions

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
python 3.11.11
2-
poetry 1.8.5
31
nodejs 21.4.0
2+
python 3.11.12
43
ruby 3.2.2
4+
uv 0.7.3

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
<img alt="gitleaks badge" src="https://img.shields.io/badge/protected%20by-gitleaks-blue">
22

33
# meetup_bot
4+
45
**Table of Contents**
6+
57
* [meetup\_bot](#meetup_bot)
68
* [Summary](#summary)
79
* [Minimum Requirements](#minimum-requirements)
@@ -18,9 +20,11 @@
1820
* [Further Reading](#further-reading)
1921

2022
## Summary
23+
2124
Use Meetup Pro API to send Slack messages before events occur.
2225

2326
## Minimum Requirements
27+
2428
* [Python 3.11+](https://www.python.org/downloads/)
2529
* [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli)
2630
* [Create a Meetup API key](https://secure.meetup.com/meetup_api/key/)
@@ -29,15 +33,21 @@ Use Meetup Pro API to send Slack messages before events occur.
2933
* [Create a Slack bot](https://api.slack.com/bot-users)
3034

3135
## Recommended Requirements
36+
3237
* [Devbox](https://www.jetpack.io/devbox/docs/quickstart/)
3338
* [Docker](https://www.docker.com/products/docker-desktop)
3439

3540
## Quickstart
41+
3642
* Clone repo
3743
* Copy `.env.example` to `.env` and fill out environment variables
3844

3945
### Python only
46+
4047
```bash
48+
python -m venv .venv
49+
source .venv/bin/activate
50+
4151
cd ./app
4252

4353
# run individual app
@@ -48,6 +58,7 @@ python main.py
4858
```
4959

5060
### Shell wrapper
61+
5162
```bash
5263
cd ./app
5364

@@ -62,6 +73,7 @@ cd ./app
6273
```
6374

6475
### Devbox
76+
6577
I.e., [Nix Package Manager](https://search.nixos.org/packages)
6678
```bash
6779
# enter dev environment
@@ -81,6 +93,7 @@ devbox run test
8193
```
8294

8395
### Docker
96+
8497
```bash
8598
cd ./app
8699

@@ -92,6 +105,7 @@ docker run --name meetup_bot -it --rm --env-file .env -p 3000:3000 meetup_bot ba
92105
```
93106

94107
### Docker Compose
108+
95109
```bash
96110
cd ./app
97111

@@ -115,6 +129,7 @@ docker-compose down --volumes
115129
```
116130

117131
## TODO
132+
118133
* Refactor authentication
119134
* passlib + bcrypt -> bcrypt (see: [AttributeError: module 'bcrypt' has no attribute '__about__' with new 4.1.1 version · Issue #684 · pyca/bcrypt](https://github.com/pyca/bcrypt/issues/684#issuecomment-1902590553))
120135
* Secured endpoints
@@ -137,6 +152,7 @@ docker-compose down --volumes
137152
* Coralogix logging
138153

139154
## Stretch Goals
155+
140156
* Indicate online vs. in-person
141157
* Time Frame
142158
* 2 hours before
@@ -180,6 +196,7 @@ docker-compose down --volumes
180196
<!-- ALL-CONTRIBUTORS-LIST:END -->
181197

182198
## Further Reading
199+
183200
[API Doc Authentication | Meetup](https://www.meetup.com/api/authentication/#p04-jwt-flow-section)
184201

185202
[How to Handle JWTs in Python](https://auth0.com/blog/how-to-handle-jwt-in-python/)
@@ -198,10 +215,6 @@ docker-compose down --volumes
198215

199216
[checkbashisms](https://command-not-found.com/checkbashisms)
200217

201-
[Efficient Python Docker Image from any Poetry Project](https://denisbrogg.hashnode.dev/efficient-python-docker-image-from-any-poetry-project)
202-
203-
[Document docker poetry best practices · python-poetry · Discussion #1879](https://github.com/python-poetry/poetry/discussions/1879#discussioncomment-216865)
204-
205218
[Building Docker images in Kubernetes | Snyk](https://snyk.io/blog/building-docker-images-kubernetes/)
206219

207220
[Kaniko, How to Build Container Image with SSH | by Yossi Cohn | HiredScore Engineering | Medium](https://medium.com/hiredscore-engineering/kaniko-builds-with-private-repository-634d5e7fa4a5)

0 commit comments

Comments
 (0)