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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ wheels/
MANIFEST

# Virtual environments
.venv/
venv/
env/
ENV/
Expand Down
1 change: 1 addition & 0 deletions .python-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.12
19 changes: 13 additions & 6 deletions BOT_SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,31 @@ This guide will help you set up the GitCord Discord bot on your server.

## Prerequisites

1. **Python 3.8 or higher** installed on your system
1. **Python 3.9 or higher** installed on your system
2. **A Discord bot token** (see [Creating a Discord Bot](#creating-a-discord-bot) below)

## Quick Setup

### 1. Install Dependencies
### 1. Install uv

```bash
pip install -r requirements.txt
$ pip install -r requirements.txt
```

### 2. Set Up Environment Variables
### 2. Install the project

```bash
$ uv build
$ pip install dist/*.whl
```

### 3. Set Up Environment Variables

You have two options:

#### Option A: Use the Setup Script (Recommended)
```bash
python setup.py
python setup-env.py
```
This will guide you through creating the `.env` file with your bot token.

Expand All @@ -34,7 +41,7 @@ DISCORD_TOKEN=your_discord_bot_token_here
### 3. Run the Bot

```bash
python bot.py
python3 -m gitcord
```

If everything is set up correctly, you should see:
Expand Down
40 changes: 40 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"

[project]
name = "gitcord"
version = "0.6.0"
description = "A Discord bot for GitOps based server structure"
readme = "README.md"
license = "GPL-3.0"
license-files = ["LICENSE"]
requires-python = ">=3.9"
authors = [
{name = "Evelyn", email = "[email protected]"}
]
dependencies = [
"discord.py>=2.5.2",
"python-dotenv==1.0.0",
"requests>=2.31.0",
"beautifulsoup4>=4.12.0",
"PyYAML>=6.0.2",
"pylint>=3.3.7",
"setuptools>=80.9.0",
]
classifiers = [
"Development Status :: 3 - Alpha",
"Intended Audience :: Developers",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
]

[project.urls]
Homepage = "https://github.com/evolvewithevan/gitcord"

[project.scripts]
gitcord = "gitcord.bot:run_bot"
2 changes: 0 additions & 2 deletions requirements-dev.txt

This file was deleted.

6 changes: 1 addition & 5 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1 @@
discord.py>=2.5.2
python-dotenv==1.0.0
requests>=2.31.0
beautifulsoup4>=4.12.0
PyYAML>=6.0.2
uv==0.7.21
43 changes: 0 additions & 43 deletions setup.py

This file was deleted.

File renamed without changes.
1 change: 0 additions & 1 deletion main.py → src/gitcord/__main__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
#!/usr/bin/env python3
"""
Main entry point for GitCord bot.
"""
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
1,025 changes: 1,025 additions & 0 deletions uv.lock

Large diffs are not rendered by default.

Loading