Initial commit

.gitattributes

@@ -0,0 +1,2 @@
+*.py text eol=lf
+*.yml.example text eol=lf

LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 Ailothaen
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 Ailothaen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,36 @@
+# RedditArchiver-standalone
+
+<p align="center"><img src="https://github.com/ailothaen/RedditArchiver/blob/main/github/logo.png?raw=true" alt="RedditArchiver logo" width="500"></p>
+
+RedditArchiver-standalone is the standalone version of RedditArchiver.
+
+"Standalone" means that you do not need a web server: the function was reduced to a simple Python script.
+
+For more information on RedditArchiver itself, see [the main repository](https://github.com/ailothaen/RedditArchiver).
+
+
+## Running the script
+
+(Replace `python3` by `py -3` if you are on Windows)
+
+Install dependencies:
+
+```bash
+python3 -m pip install -r dependencies
+```
+
+Edit the file `config.yml` to put all the informations needed to connect (client ID, client secret and refresh token).
+
+If you have no clue about what these options are, follow these steps:
+1. [Go here](https://www.reddit.com/prefs/apps) and create an app
+2. Use the "script" type, and put `localhost:8080` as redirect URI (the other options do not matter)
+3. Take note of your client ID and client secret
+4. To get your refresh token, you can use [this script](https://praw.readthedocs.io/en/stable/tutorials/refresh_token.html#obtaining-refresh-tokens) (you only need the "read" scope)
+5. Edit the config file to put these three elements in it.
+
+For information about the usage of the script, run `python3 RedditArchiver -h`.
+
+
+## Licensing
+
+This software is licensed [with MIT license](https://github.com/ailothaen/RedditArchiver/blob/main/LICENSE).