Welcome to mathecamp-konfigurator’s documentation!

Contents:

mathecamp-konfigurator

https://img.shields.io/pypi/v/mathecamp_konfigurator.svg https://img.shields.io/travis/svenpruefer/mathecamp-konfigurator.svg Documentation Status Updates

Mathecamp-konfigurator allows you to plan and organize your own Mathecamp.

You probably have already experienced the following problem: You suddenly want to organize a new mathcamp, i.e. a summer camp for say high school students that are intereseted in mathematics. And then you notice that you don’t know where to start and how to plan and organize such a large event. But don’t be scared any longer:

mathecamp-konfigurator to the rescue!

This program incorporates ideas and experience gained during the planning and organization of the Mathecamp Augsburg. It is easily customizable and is in fact also capable of organizing any other summer camp. All the data is saved in a way that makes it possible to access it via other means, too, in case there is urgent need. Furthermore the GUI offers some easy ways to view and edit all the information.

Features

  • (Planned) Overview over registered participants, guests and counselors
  • (Planned) Easy access to many common necessary functions such as producing tables of participants arriving by bus, counting registered people or printing a list of all registered email addresses
  • (Planned) Financial planning
  • (Planned) Scheduling
  • (Planned) GUI
  • (Planned) Synchronization with other devices in local network

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Impressum

You can find the authors website on Musmehl.

Installation

Stable release

To install mathecamp-konfigurator, run this command in your terminal:

$ pip install mathecamp_konfigurator

This is the preferred method to install mathecamp-konfigurator, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for mathecamp-konfigurator can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/svenpruefer/mathecamp_konfigurator

Or download the tarball:

$ curl  -OL https://github.com/svenpruefer/mathecamp_konfigurator/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

To use mathecamp-konfigurator in a project:

import mathecamp_konfigurator

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/svenpruefer/mathecamp_konfigurator/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

mathecamp-konfigurator could always use more documentation, whether as part of the official mathecamp-konfigurator docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/svenpruefer/mathecamp_konfigurator/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up mathecamp_konfigurator for local development.

  1. Fork the mathecamp_konfigurator repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/mathecamp_konfigurator.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv mathecamp_konfigurator
$ cd mathecamp_konfigurator/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 mathecamp_konfigurator tests
$ python setup.py test or py.test
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/svenpruefer/mathecamp_konfigurator/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ py.test tests.test_mathecamp_konfigurator

Credits

Development Lead

Contributors

None yet. Why not be the first?

History

0.1.0 (2017-12-26)

  • First release on PyPI.

Indices and tables