From 0e536f476a76193654941f4ad35287583e4c8997 Mon Sep 17 00:00:00 2001 From: Joscha Date: Thu, 25 Apr 2019 11:48:58 +0000 Subject: [PATCH] Reorganize project structure --- .gitignore | 10 +++++++--- README.md | 12 ++++++++++++ requirements.txt | 8 -------- setup.py | 15 +++++++++++++++ 4 files changed, 34 insertions(+), 11 deletions(-) create mode 100644 README.md delete mode 100644 requirements.txt create mode 100644 setup.py diff --git a/.gitignore b/.gitignore index 918bd27..e6de7ea 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,12 @@ -**/__pycache__/ -.tmp/ +# python stuff +__pycache__/ + +# venv stuff bin/ include/ lib/ lib64 -pip-selfcheck.json pyvenv.cfg + +.tmp/ +pip-selfcheck.json diff --git a/README.md b/README.md new file mode 100644 index 0000000..1129e09 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# PFERD (**P**rogramm **F**ür's **E**infache **R**unterladen von **D**ateien) + +## Installation + +Ensure that you have at least Python 3.7 installed. + +To install PFERD or update your installation to the latest version, run: +``` +$ pip install git+https://github.com/Garmelon/PFERD@v0.1.0 +``` + +The use of [venv](https://docs.python.org/3/library/venv.html) is recommended. diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index 13bde7d..0000000 --- a/requirements.txt +++ /dev/null @@ -1,8 +0,0 @@ -aiohttp==3.4.4 -async-timeout==3.0.1 -attrs==18.2.0 -beautifulsoup4==4.6.3 -chardet==3.0.4 -idna==2.7 -multidict==4.4.2 -yarl==1.2.6 diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..c10b38c --- /dev/null +++ b/setup.py @@ -0,0 +1,15 @@ +from setuptools import setup + +setup( + name="PFERD", + version="0.1.0", + packages=["PFERD"], + install_requires=[ + "requests>=2.21.0", + "beautifulsoup4>=4.7.1", + ], +) + +# When updating the version, also: +# - update the README.md installation instructions +# - set a tag on the update commit