summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorromina xj ix k <romina@sunshinegardens.org>2022-02-25 14:48:49 -0700
committerromina xj ix k <romina@sunshinegardens.org>2022-02-25 14:48:49 -0700
commit745a839183e25d2ff27825b51332153f15d57f88 (patch)
tree346b24c6e9f1d0c5054f5e5d7678462df97dd507
parent1ef72a97605bfe8a1267d113826afe6897d27976 (diff)
update readme
-rw-r--r--README.txt14
-rw-r--r--readme.md14
2 files changed, 14 insertions, 14 deletions
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..9936a34
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,14 @@
+# Gitea Issues Exporter
+
+A small python program that fetches Gitea issues (from a given organization/repo) and exports to json.
+
+## How to run
+
+* Install python if not yet installed.
+* Prepare Gitea access token. This be easily obtained in your Gitea *Settings >> Applications >> Manage Access Tokens* section.
+* 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).
+* set environment variables listed in `main.py`, such as Gitea access token, repo name, organization name and Gitea URL.
+* Run the python program from command line (or IDE if you use) - `python3.9 main.py`.
+* The program will generate `open_issues.json` and `closed_issues.json` in the same directory as main.py.
+
+Enjoy. Hope it helps someone.
diff --git a/readme.md b/readme.md
deleted file mode 100644
index a883dd8..0000000
--- a/readme.md
+++ /dev/null
@@ -1,14 +0,0 @@
-## 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