<commit_before>CodeSelfStudy.com
=================

This is the CodeSelfStudy.com website rebuilt in Flask/Python. More info will be posted here soon.

Branches
--------

- :code:`master` -- don't use the master branch.
- :code:`dev` -- you can edit the dev branch, but don't upload breaking changes.

Structure
---------

1. app -- contains all of the application code
2. docs -- contains any documentation that we generate
3. sandbox -- contains any code snippets and experiments that people want to share with the team, without adding that code to the actual application

Setup
-----

You should have a :code:`app/instance/config.py` file with sensitive variables in it. Required ones are below.

.. codeblock
    SECRET_KEY = 'keyboard k41'
    MONGODB_SETTINGS = {'DB': 'codeselfstudy1'}


Resources
---------

- `Flask Quickstart <http://flask.pocoo.org/docs/0.10/quickstart/>`_ -- a quick overview to Flask.
- `Flask example <https://github.com/CodeSelfStudy/Asteroid-API-Example>`_ -- a quick example application in Flask.
- `Restructured Text Cheatsheet <https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst>`_ -- This is a quick cheat sheet to help with formatting .rst documents.

Coding Format
-------------<commit_msg>Fix typo<commit_after>CodeSelfStudy.com
=================

This is the CodeSelfStudy.com website rebuilt in Flask/Python. More info will be posted here soon.

Branches
--------

- :code:`master` -- don't use the master branch.
- :code:`dev` -- you can edit the dev branch, but don't upload breaking changes.

Structure
---------

1. app -- contains all of the application code
2. docs -- contains any documentation that we generate
3. sandbox -- contains any code snippets and experiments that people want to share with the team, without adding that code to the actual application

Setup
-----

You should have a :code:`app/instance/config.py` file with sensitive variables in it. Required ones are below.

.. code-block:: python
    SECRET_KEY = 'keyboard k41'
    MONGODB_SETTINGS = {'DB': 'codeselfstudy1'}


Resources
---------

- `Flask Quickstart <http://flask.pocoo.org/docs/0.10/quickstart/>`_ -- a quick overview to Flask.
- `Flask example <https://github.com/CodeSelfStudy/Asteroid-API-Example>`_ -- a quick example application in Flask.
- `Restructured Text Cheatsheet <https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst>`_ -- This is a quick cheat sheet to help with formatting .rst documents.

Coding Format
-------------
{'fraction_non_alphanumeric': 0.14080574391703232, 'fraction_numerical': 0.007179896290386917, 'mean_word_length': 3.3092783505154637, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4167759', 'n_tokens_mistral': 762, 'n_tokens_neox': 719, 'n_words': 272}