Upload files/tits.md with huggingface_hub

files/tits.md

@@ -0,0 +1,35 @@
+# gh-issue-pull
+
+Stateless endpoint to sample obfuscated issues from SWEBench.
+
+## Running
+First, set your `.env` using the `.env.example` file. Then:
+
+If using poetry:
+```sh
+poetry install && poetry shell
+```
+If using `virtualenv`:
+```sh
+python3 -m venv venv
+source venv/bin/activate
+python3 -m pip install --upgrade pip
+python3 -m pip install -r requirements.txt
+```
+
+Then, run the server via:
+```sh
+python3 -m uvicorn gh_issue_pull.main:app --reload
+```
+
+The server will take a while to start up as it has to pull all the SWEBench issues and save them to a local db.
+
+Test the program by running
+```shell
+curl "http://127.0.0.1:8000/task" | jq
+```
+
+If you want to quickly make the endpoint publicly available, the easiest way is to use localtunnel:
+```shell
+lt --port 8000
+```