Merge branch 'develop'

Author: rsnitsch

.gitignore

@@ -1,2 +1,6 @@
 docs/build/
 src/__pycache__/
+Pipfile.lock
+dist
+src/py3createtorrent.egg-info
+build

BUILD.md

@@ -0,0 +1,14 @@
+# Building
+
+python setup.py sdist
+python setup.py bdist_wheel
+
+# Uploading
+
+twine upload dist/*
+twine upload --repository testpypi dist/*
+
+# Testing
+
+pip install py3createtorrent
+pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple py3createtorrent

LICENSE renamed to LICENSE.txt

@@ -0,0 +1,13 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+sphinx = "~=3.1"
+mypy = "~=0.782"
+yapf = "~=0.30"
+twine = "*"
+
+[packages]
+"bencode.py" = "~=4.0"

Pipfile

@@ -0,0 +1,52 @@
+py3createtorrent
+================
+
+*Create torrents via command line!*
+
+py3createtorrent is a comprehensive shell/commandline utility for creating torrents (Linux & Windows).
+
+Features
+--------
+
+Some of the features:
+
+* you can create **huge torrents** for any amount of data
+* you can add a **comment** to the torrent file
+* you can create **private torrents** (disabled DHT, ...)
+* you can create torrents with **multiple trackers**
+* you can create **trackerless torrents** (not yet released, but already implemented in develop branch)
+* you can add **webseeds** to torrents
+* you can **exclude specific files/folders**
+* you can exclude files/folders based on **regular expressions**
+* you can specify **custom piece sizes**
+* you can specify custom creation dates
+
+Basic usage
+-----------
+
+Creating a torrent is as simple as:
+
+    py3createtorrent -t udp://tracker.opentrackr.org:1337/announce file_or_folder
+
+The shortcut ``bestN`` can be used for conveniently adding the best N trackers
+from [ngosang/trackerslist](https://github.com/ngosang/trackerslist). Example:
+
+    py3createtorrent -t best3 file_or_folder
+
+Multiple trackers can also be specified manually by using `-t` multiple times, for example:
+
+    py3createtorrent -t udp://tracker.opentrackr.org:1337/announce -t udp://tracker.coppersurfer.tk:6969/announce file_or_folder
+
+Install
+-------
+
+You can install py3createtorrent by executing:
+
+    pip3 install py3createtorrent
+
+Of course, you need to have Python 3 installed on your system. py3createtorrent requires Python 3.5 or later.
+
+Full documentation
+------------------
+
+https://py3createtorrent.readthedocs.io/en/develop/user.html

README.md

@@ -1,6 +1,33 @@
 Changelog
 =========
 
+Version 1.0.0b1 (beta version)
+------------------------------
+
+*Release date: 2021/01/04*
+
+* changed: **requires Python 3.5+ now**
+* changed: specifying trackers is now optional with the new ``-t`` switch, thus **trackerless torrents are now
+  possible**
+* added: **bestN shortcut**! It is now possible to add the best N trackers from `ngosang/trackerslist <https://github.com/ngosang/trackerslist>`_
+  by using the new `bestN shortcut <user.html#bestn-automatically-add-the-best-trackers>`__
+* changed: use **external JSON files for configuration**, by default try to load ``.py3createtorrent.cfg``
+  from user's home directory
+* added: DHT bootstrap nodes can now be specified with the new ``--node`` switch (doing so is recommended for
+  trackerless torrents)
+* added: **webseed support** with the new ``--webseed`` switch (GetRight style, i.e. `<http://bittorrent.org/beps/bep_0019.html>`_)
+* changed: increased max piece size to 16 MiB
+* changed: show warning if piece size is not a multiple of 16 KiB
+* changed: updated the default trackers (openbt is now opentrackr, dropped publicbt, added cyberia and coppersurfer)
+* added: Pipfile and Pipfile.lock for pipenv support
+* added: README.md
+* changed: improved performance of single file torrent creation
+* refactored: switched to bencode.py module for encoding the torrent data
+* refactored: switched from optparse to argparse
+* refactored: reformatted code with yapf, using a new column limit of 120
+* refactored: added type hints to enable analysis with mypy (we use Python's typing module which was added in
+  Python 3.5, thus Python 3.5 is the new minimum version that is required)
+
 Version 0.9.7
 -------------
 

docs/source/changelog.rst

@@ -48,9 +48,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.9'
+version = '1.0'
 # The full version, including alpha/beta/rc tags.
-release = '0.9.7'
+release = '1.0.0.dev4'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/source/conf.py

@@ -4,7 +4,7 @@ Developer documentation
 Todo
 ----
 
-* use configuration files instead of requiring users to edit the script
+* implement multi-threading
 * add the ability to define how the announce-list should be constructed in detail
   (tracker tiers etc., see `Multitracker Metadata
   Extension <http://bittorrent.org/beps/bep_0012.html>`_)