summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorivansivak <ivansivak@outlook.com>2022-01-21 17:19:26 +0100
committerivansivak <ivansivak@outlook.com>2022-01-21 17:19:26 +0100
commite58b99896d52696cdca7ca341fda73edddb254b0 (patch)
tree7a8d4e14958fee241bf174c67d463d534a4d0d20
parent6a06f6b7bbc4874790258e484071ce17d71c9be0 (diff)
minor updates
-rw-r--r--LICENSE19
-rw-r--r--readme.md14
2 files changed, 33 insertions, 0 deletions
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..1ce9e3f
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2022 BotX s.r.o., Ivan Sivak
+
+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. \ No newline at end of file
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..a883dd8
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,14 @@
+## Gitea Issues Exporter
+A small python program that fetches Gitea issues (from a given organization/repo) and exports to CSV (Excel).
+
+Currently, only issue title is exported. This can be easily adjusted, though (in `dump_to_csv` method).
+
+## How to run
+1. Install python if not yet installed. I'm using `python3.9`.
+2. Prepare Gitea access token. This be easily obtained in your Gitea *Settings >> Applications >> Manage Access Tokens* section.
+3. Make sure you have `giteapy` pip package installed (if not, just go to https://pypi.org/project/giteapy/ and easily install this great python lib).
+4. Modify the `main.py` top part of the code with basic config variables, such as Gitea access token, repo name, organization name and Gitea URL.
+5. Just run the python program from command line (or IDE if you use) - `python3.9 main.py`.
+6. The program will generate `open_issues.csv` and `closed_issues.csv` in the same directory as main.py.
+
+Enjoy. Hope it helps someone. \ No newline at end of file