Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
* text=auto
static/* linguist-vendored
templates/* linguist-vendored
wordlists/* linguist-vendored
wordlists/* linguist-vendored
18 changes: 18 additions & 0 deletions .github/workflows/linters.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: CI/CD
on:
push:
pull_request:

jobs:
linters:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- uses: astral-sh/setup-uv@v3
- run: uv python install
- run: uv sync --all-extras --dev
- run: uv run ruff check --select I --output-format=github clonenames
- run: uv run ruff check --output-format=github clonenames
- run: uv run ruff format --diff clonenames
- run: uv run mypy clonenames
26 changes: 26 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-toml
- id: check-added-large-files
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.12.0
hooks:
- id: ruff-check
name: check
- id: ruff-check
name: imports
args: [--select=I]
- id: ruff-format
types: [file]
- repo: local
hooks:
- id: mypy
name: mypy
entry: mypy
language: python
types: [python]
args: [--strict]
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -671,4 +671,4 @@ into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
24 changes: 10 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,37 +10,33 @@ Unlike the original game, Clonenames allows up to 4 teams, and game boards with
* Cards Against Humanity
* Gen. 1 Pokemon
* PYTHON3 BUILTINS!!!

And it's very easy to add any other word lists. They're just new-line delineated files.

[![](screenshot.png)](#)

## Getting Started
### Prerequisites/Required Libraries
```
flask==1.0.2
flask-socketio==3.2.1
eventlet==0.24.1
flask>=3.1.1
flask-socketio>=5.5.1
eventlet>=0.40.0
```

Clone or download this repository, and install the dependencies.
```
git clone https://github.com/cazier/clonenames.git
cd clonenames
```
If you have/use pipenv, install the dependencies, then start a shell:
```
pipenv install
pipenv shell
You can start it directly using uv with:
```
Or if you don't:
$ uv run python clonenames/web.py
```
pip install -r requirements.txt
```

Then run it with:
Or create and activate a virtual environment with:
```
python web.py
$ uv venv
$ source venv/bin/activate
(venv) $ python web.py
```
### Play!
Open a web browser to [127.0.0.1:5000](127.0.0.1:5000) and you can start a game!
Expand Down
2 changes: 1 addition & 1 deletion deployment/DEPLOYMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ It took me a *really* long time to figure this out. I had some rather specific n

## Summary

Again, I can't vouch for anyone else or there specific configuration or settings, but I'm happy to try and help as able. This worked for me on a brand new DO droplet.
Again, I can't vouch for anyone else or there specific configuration or settings, but I'm happy to try and help as able. This worked for me on a brand new DO droplet.
2 changes: 1 addition & 1 deletion deployment/nginx
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ server {
proxy_pass http://127.0.0.1:1234/socket.io;
}

}
}
2 changes: 1 addition & 1 deletion deployment/sample.service
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ Environment="PATH=/home/users_name/clonenames/venv/bin"
ExecStart=/home/users_name/clonenames/venv/bin/python web.py

[Install]
WantedBy=multi-user.target
WantedBy=multi-user.target
14 changes: 14 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,19 @@ build-backend = "setuptools.build_meta"
[dependency-groups]
dev = [
"mypy>=1.16.1",
"pre-commit>=4.2.0",
"ruff>=0.12.0",
]

# BUILDING
[tool.setuptools]
packages = ["clonenames"]

# FORMATTING
[tool.ruff]
line-length = 120

# LINTING
[tool.mypy]
strict = true
explicit_package_bases = true
103 changes: 103 additions & 0 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading