<commit_before>PleasShare
=================

PleaseShare is a file-sharing website that aims to decentralize file-sharing through the use of torrent, DHT, and webseeds.


License
-------

PleaseShare is released under the terms of the `GNU Affero General
Public License v3`_.

PleaseShare also contains some files from the `Deluge torrent client`_, which is licenced under the `GNU General Public Licence v3`_.

.. _GNU Affero General Public License v3 : http://www.gnu.org/licenses/agpl-3.0.html
.. _Deluge torrent client : http://deluge-torrent.org/
.. _GNU General Public Licence v3 : https://www.gnu.org/licenses/gpl-3.0.html


Get started
-----------

Retrieve the project from gitorious_:

.. _gitorious : https://git.gitorious.org/pleaseshare/pleaseshare.git

::

  $ git clone git://gitorious.org/pleaseshare/pleaseshare.git

Then install the dependencies:

::

  $ cd pleaseshare
  $ pip install -r requirements.txt

And manage it as you would do with any other django application.
Also, do not forget to use a REAL web server to handle the uploaded files, else the webseeds won’t work, since the built-in file server do not support resuming.<commit_msg>[doc] Added some advice<commit_after>PleasShare
=================

PleaseShare is a file-sharing website that aims to decentralize file-sharing through the use of torrent, DHT, and webseeds.


License
-------

PleaseShare is released under the terms of the `GNU Affero General
Public License v3`_.

PleaseShare also contains some files from the `Deluge torrent client`_, which is licenced under the `GNU General Public Licence v3`_.

.. _GNU Affero General Public License v3 : http://www.gnu.org/licenses/agpl-3.0.html
.. _Deluge torrent client : http://deluge-torrent.org/
.. _GNU General Public Licence v3 : https://www.gnu.org/licenses/gpl-3.0.html


Get started
-----------

Retrieve the project from gitorious_:

.. _gitorious : https://git.gitorious.org/pleaseshare/pleaseshare.git

::

  $ git clone git://gitorious.org/pleaseshare/pleaseshare.git

Then install the dependencies (assuming you are using a virtualenv):

::

  $ cd pleaseshare
  $ pip install -r requirements.txt

And manage it as you would do with any other django application.
Do not forget to add your website in the "Sites" section, because the web seed generated will be using example.com if you don’t.
Also, do not forget to use a REAL web server to handle the uploaded files, else the webseeds won’t work, since the built-in file server do not support resuming file transfers.

{'fraction_non_alphanumeric': 0.10162763001190948, 'fraction_numerical': 0.006351726875744343, 'mean_word_length': 3.8091603053435112, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 4, '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': '6901987', 'n_tokens_mistral': 774, 'n_tokens_neox': 731, 'n_words': 301}