Welcome to meeting’s documentation!¶
Warning
Beta software You are using a software that has not reached a stable version yet. Please beware that interfaces might change, APIs might disappear and general breakage can occur before 1.0.
If you plan to use this software for something important, please read the roadmap, and the issue tracker in Github. If you are unsure about the future of this project, please talk to the developers, or (better yet) get involved with the development of python-boilerplate!
Meeting¶
Usage¶
Festival management application: Tickets E-Commerce, Tickets validation on Lobby (Web, Paper, Guest, Local Purchase) and Sells on Wristband/Card (Beverage, Food, Souvenir, etc).
Documentation¶
The documenation is written in rst format. It’s available on the folder docs/. To write or read it in realtime install the sphinx dependencies using:
$ python -m pip install docs/requirements.txt
And then execute the docs server via the command below:
$ make docs
Your browser will open the local docs website (Running on port 8000 by default).
Thanks to¶
Project structure, documentation generation and other stuff from these python boilerplate package projects:
- https://github.com/fabiommendes/python-boilerplate
- https://github.com/mtchavez/python-package-boilerplate
Topics¶
Installation instructions¶
meeting can be installed using pip:
$ python -m pip install meeting
This command will fetch the archive and its dependencies from the internet and install them.
If you’ve downloaded the tarball, unpack it, and execute:
$ python setup.py install --user
You might prefer to install it as system-wide. In this case, skip the --user
option and execute as superuser by prepending the command with sudo
.
Troubleshoot¶
Windows users may find that these command will only works if typed from Python’s installation directory.
Some Linux distributions (e.g. Ubuntu) install Python without installing pip.
Please install it before. If you don’t have root privileges, download the
get-pip.py script at https://bootstrap.pypa.io/get-pip.py and execute it as
python get-pip.py --user
.
License¶
The MIT License (MIT)
Copyright (c) 2016 mtchavez
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.