# YEPcord server
Unofficial discord backend implementation in python.
[](https://stand-with-ukraine.pp.ua)
# Setup
**Requirements:**
- Python 3.9+
- Poetry (Optional)
**Setup**:
1. Clone yepcord repository:
```bash
git clone https://github.com/yepcord/server yepcord-server && cd yepcord-server
```
2. Install requirements:
```bash
poetry install
```
3. (Optional) Install and start redis, mysql/mariadb.
4. (Optional) Fill config file (example in config.example.py) with your values.
5. Run (with your config):
```bash
poetry run yepcord migrate -c yepcord-config.py
poetry run yepcord run_all -c yepcord-config.py
```
Run (with default config):
```bash
poetry run yepcord migrate
poetry run yepcord run_all
```
**Install as python package and run (simple method):**
1. Install yepcord-server from pypi:
```bash
pip install yepcord-server
```
2. (Optional) Install and start redis, mysql/mariadb.
3. (Optional) Fill config file (example in config.example.py) with your values.
4. Run (with your config):
```bash
yepcord migrate -c yepcord-config.py
yepcord run_all -c yepcord-config.py
```
Run (with default config):
```bash
yepcord migrate
yepcord run_all
```
### License
**Any commit before 10.04.2023 is also covered by this license.**
Copyright (C) 2023 RuslanUC
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation version 3 of the
License
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see https://www.gnu.org/licenses/agpl-3.0.de.html
Raw data
{
"_id": null,
"home_page": "https://github.com/yepcord/server",
"name": "yepcord-server",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "yepcord,chat,discord,chat-server,chat-backend,discord-backend",
"author": "RuslanUC",
"author_email": "dev_ruslan_uc@protonmail.com",
"download_url": "https://files.pythonhosted.org/packages/1b/c0/68e3ca336f6cc4601bbbffd8fc1a74ac328b3564d0eb558ae3c72c487f99/yepcord_server-1.0.0b3.tar.gz",
"platform": null,
"description": "# YEPcord server\nUnofficial discord backend implementation in python.\n\n[](https://stand-with-ukraine.pp.ua)\n\n# Setup\n**Requirements:**\n - Python 3.9+\n - Poetry (Optional)\n \n**Setup**:\n1. Clone yepcord repository:\n ```bash\n git clone https://github.com/yepcord/server yepcord-server && cd yepcord-server\n ```\n2. Install requirements:\n ```bash\n poetry install\n ```\n3. (Optional) Install and start redis, mysql/mariadb.\n4. (Optional) Fill config file (example in config.example.py) with your values.\n5. Run (with your config): \n ```bash\n poetry run yepcord migrate -c yepcord-config.py\n poetry run yepcord run_all -c yepcord-config.py\n ```\n Run (with default config): \n ```bash\n poetry run yepcord migrate\n poetry run yepcord run_all\n ```\n \n**Install as python package and run (simple method):**\n1. Install yepcord-server from pypi:\n ```bash\n pip install yepcord-server\n ```\n2. (Optional) Install and start redis, mysql/mariadb.\n3. (Optional) Fill config file (example in config.example.py) with your values.\n4. Run (with your config): \n ```bash\n yepcord migrate -c yepcord-config.py\n yepcord run_all -c yepcord-config.py\n ```\n Run (with default config): \n ```bash\n yepcord migrate\n yepcord run_all\n ```\n\n\n### License\n\n**Any commit before 10.04.2023 is also covered by this license.**\n\nCopyright (C) 2023 RuslanUC\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU Affero General Public License as\npublished by the Free Software Foundation version 3 of the\nLicense\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU Affero General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License\nalong with this program. If not, see https://www.gnu.org/licenses/agpl-3.0.de.html",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "YEPCord - Free open source selfhostable fully discord-compatible chat",
"version": "1.0.0b3",
"project_urls": {
"Homepage": "https://github.com/yepcord/server",
"Repository": "https://github.com/yepcord/server"
},
"split_keywords": [
"yepcord",
"chat",
"discord",
"chat-server",
"chat-backend",
"discord-backend"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ce753e028111e1c4540863da6bc200051d7312549f00ea28e19de9e916bd0307",
"md5": "2c42c44e1df123b1d17f4dca30e7bdbf",
"sha256": "018e7b4f6e02cf36b542e383c3055d4e856de5a2bda8ace66f0b414a02132acf"
},
"downloads": -1,
"filename": "yepcord_server-1.0.0b3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2c42c44e1df123b1d17f4dca30e7bdbf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 211812,
"upload_time": "2023-11-22T16:13:16",
"upload_time_iso_8601": "2023-11-22T16:13:16.052332Z",
"url": "https://files.pythonhosted.org/packages/ce/75/3e028111e1c4540863da6bc200051d7312549f00ea28e19de9e916bd0307/yepcord_server-1.0.0b3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1bc068e3ca336f6cc4601bbbffd8fc1a74ac328b3564d0eb558ae3c72c487f99",
"md5": "34f62e7ffbb71475dbf34222b8722b44",
"sha256": "fb45378d91fb056619d00b9a6cd746fa604ce93a1a5082c27a0123c1252ac5c3"
},
"downloads": -1,
"filename": "yepcord_server-1.0.0b3.tar.gz",
"has_sig": false,
"md5_digest": "34f62e7ffbb71475dbf34222b8722b44",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 137329,
"upload_time": "2023-11-22T16:13:18",
"upload_time_iso_8601": "2023-11-22T16:13:18.552969Z",
"url": "https://files.pythonhosted.org/packages/1b/c0/68e3ca336f6cc4601bbbffd8fc1a74ac328b3564d0eb558ae3c72c487f99/yepcord_server-1.0.0b3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-22 16:13:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yepcord",
"github_project": "server",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "yepcord-server"
}
JSON
