Skip to content
BYCEPS is a tool to prepare and operate LAN parties (even under different brands), big (1,000+ attendees) and small, both online on the Internet and locally as an intranet system, for both organizers and attendees. [Work in progress.]
Python HTML CSS Other
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
byceps Display newsletter subscription states in user admin profile Aug 19, 2019
config Pass authorization header to fix tourney API tests Aug 3, 2019
docs Update instructions on virtual environment installation to not use th… Aug 10, 2019
scripts Use formatted string literals in scripts Aug 11, 2019
sites Change path of site-specific template overrides Mar 2, 2019
testfixtures Remove session token fixture factory, use session service instead Aug 6, 2019
tests Adjust test to newsletter list configuration for brand Aug 18, 2019
.editorconfig Rearrange EditorConfig file, fix indentation size for Python files Nov 7, 2017
.gitignore Remove tox usage Aug 12, 2019
.scrutinizer.yml Enable Scrutinizer code rating Jul 14, 2018
.travis.yml Adjust Travis CI config to explicitly install dependencies before run… Aug 12, 2019
AUTHORS.rst Initial population with basic layout/styling, a user system with auth… Jul 22, 2014
Dockerfile Add `Dockerfile` Jul 24, 2019
LICENSE Update copyright notes for 2019 Jan 1, 2019
README.rst Remove `test` setup command alias, suggest to run just `pytest` inste… Aug 12, 2019
app.py Fix admin mode with static file serving Mar 3, 2019
app_metrics.py Add separate Flask app that contains only the metrics blueprint Jan 8, 2019
requirements-development.txt Update mypy to v0.720 (from v0.701) Jul 24, 2019
requirements-docs.txt Add requirements file for documentation toolchain Jun 17, 2019
requirements-test.txt Remove tox usage Aug 12, 2019
requirements.txt Upgrade to SQLAlchemy v1.3.6 (from v1.3.5) Aug 10, 2019
serve.py Update copyright notes for 2019 Jan 1, 2019
setup.cfg Remove `test` setup command alias, suggest to run just `pytest` inste… Aug 12, 2019
setup.py Raise required Python version to 3.6 (from 3.5) Aug 10, 2019
worker.py Pass app object to `get_queue` Mar 15, 2019

README.rst

BYCEPS

BYCEPS is the Bring-Your-Computer Event Processing System.

It is a tool to prepare and operate a LAN party, both online on the Internet and locally as an intranet system, for both organizers and attendees.

The system incorporates both experience from more than 15 years of organizing LAN parties as well as concepts and source code developed for more than a decade.

Parties using BYCEPS:

  • Since 2014, BYCEPS is the foundation of the public website and local party intranet of the LANresort (300+ attendees) event series.
  • In 2016, LANresort Bostalsee was launched on BYCEPS.
  • In 2017, NorthCon (1,300+ attendees) was relaunched on BYCEPS.
Copyright:2006-2019 Jochen Kupperschmidt
License:Modified BSD, see LICENSE for details.
Website:https://byceps.nwsnet.de/

Code Status

Build Status Scrutinizer Code Quality Code Climate

Installation

See docs/installation.rst.

Testing

In the activated virtual environment, install the testing dependencies:

(venv)$ pip install -r requirements-test.txt

Run the tests:

(venv)$ pytest

Serving

To spin up a local server (only for development purposes!) on port 5000 with debugging middleware and in-browser code evaluation:

$ BYCEPS_CONFIG=../config/development_admin.py FLASK_ENV=development flask run

In a production environment, it is recommended to have the application served by uWSGI or Gunicorn.

It is furthermore recommended to run it locally behind nginx and have the latter both serve static files and provide SSL encryption.

Shell

The application shell is an interactive command line that gives access to BYCEPS' functionality as well as the persisted data.

(venv)$ BYCEPS_CONFIG=../config/development_admin.py FLASK_APP=app.py flask shell

Installation of an extra package makes the shell easier to use due to features like command history and auto-completion:

(venv)$ pip install flask-shell-ipython
You can’t perform that action at this time.