-
-
\ No newline at end of file
diff --git a/.idea/compiler.xml b/.idea/compiler.xml
deleted file mode 100644
index 96cc43e..0000000
--- a/.idea/compiler.xml
+++ /dev/null
@@ -1,22 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/.idea/copyright/profiles_settings.xml b/.idea/copyright/profiles_settings.xml
deleted file mode 100644
index e7bedf3..0000000
--- a/.idea/copyright/profiles_settings.xml
+++ /dev/null
@@ -1,3 +0,0 @@
-
-
-
\ No newline at end of file
diff --git a/.idea/deployment.xml b/.idea/deployment.xml
deleted file mode 100644
index 4f6e5c6..0000000
--- a/.idea/deployment.xml
+++ /dev/null
@@ -1,14 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/.idea/encodings.xml b/.idea/encodings.xml
deleted file mode 100644
index 97626ba..0000000
--- a/.idea/encodings.xml
+++ /dev/null
@@ -1,6 +0,0 @@
-
-
-
-
-
-
\ No newline at end of file
diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
deleted file mode 100644
index ecd817f..0000000
--- a/.idea/inspectionProfiles/Project_Default.xml
+++ /dev/null
@@ -1,9 +0,0 @@
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/.idea/inspectionProfiles/profiles_settings.xml b/.idea/inspectionProfiles/profiles_settings.xml
deleted file mode 100644
index 3b31283..0000000
--- a/.idea/inspectionProfiles/profiles_settings.xml
+++ /dev/null
@@ -1,7 +0,0 @@
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/.idea/limesurveyrc2api.iml b/.idea/limesurveyrc2api.iml
deleted file mode 100644
index 6c348c5..0000000
--- a/.idea/limesurveyrc2api.iml
+++ /dev/null
@@ -1,14 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/.idea/misc.xml b/.idea/misc.xml
deleted file mode 100644
index 7fb6195..0000000
--- a/.idea/misc.xml
+++ /dev/null
@@ -1,4 +0,0 @@
-
-
-
-
\ No newline at end of file
diff --git a/.idea/modules.xml b/.idea/modules.xml
deleted file mode 100644
index a367991..0000000
--- a/.idea/modules.xml
+++ /dev/null
@@ -1,8 +0,0 @@
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
deleted file mode 100644
index 94a25f7..0000000
--- a/.idea/vcs.xml
+++ /dev/null
@@ -1,6 +0,0 @@
-
-
-
-
-
-
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
index 256b192..fd6f2b6 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,6 +1,6 @@
The MIT License (MIT)
-Copyright (c) 2014 Lindsay Stevens, UNSW Australia
+Copyright (c) 2023 Lindsay Stevens
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
index 912c83e..1c85db4 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,18 @@
This module provides a class which can be used as a client for interacting with LimeSurvey Remote Control 2 API.
+### Install
+From pip:
+```shell
+pip install limesurveyrc2api
+```
+
+or from GitHub, for example using the master branch:
+```shell
+pip install https://github.com/lindsay-stevens/limesurveyrc2api/archive/master.zip
+```
+
+
### Example Usage
The tests are a good place to refer to for api usage, until proper docs are written, anyway. Here is how to get a list of surveys.
@@ -57,6 +69,26 @@ Where possible, error messages from the RC2API are translated into Python except
## Development
+### Setup
+```shell
+# Get a copy of the repository.
+mkdir -P ~/repos/limesurveyrc2api
+cd ~/repos/limesurveyrc2api
+git clone https://github.com/lindsay-stevens/limesurveyrc2api.git repo
+
+# Create and activate a virtual environment for the install.
+/usr/local/bin/python3.9 -m venv venv
+source venv/bin/activate
+
+# Install limesurveyrc2api, and it's development dependencies.
+cd ~/repos/limesurveyrc2api/repo
+pip install -e .
+pip install -r dev_requirements.pip
+
+# Leave the virtualenv.
+deactivate
+```
+
### References
diff --git a/dev_requirements.pip b/dev_requirements.pip
new file mode 100644
index 0000000..4745b6f
--- /dev/null
+++ b/dev_requirements.pip
@@ -0,0 +1,2 @@
+-e .
+aiosmtpd==1.0.0
diff --git a/limesurveyrc2api/__init__.py b/limesurveyrc2api/__init__.py
index bcf374d..8c0d5d5 100644
--- a/limesurveyrc2api/__init__.py
+++ b/limesurveyrc2api/__init__.py
@@ -1 +1 @@
-__version__ = "2017.1"
+__version__ = "2.0.0"
diff --git a/requirements.txt b/requirements.txt
deleted file mode 100644
index 097d3b2..0000000
--- a/requirements.txt
+++ /dev/null
@@ -1,3 +0,0 @@
--e .
-requests
-aiosmtpd
\ No newline at end of file
diff --git a/setup.py b/setup.py
index 095bede..68f62ca 100644
--- a/setup.py
+++ b/setup.py
@@ -1,25 +1,27 @@
-from setuptools import setup
+from setuptools import find_packages, setup
from limesurveyrc2api import __version__
setup(
name="limesurveyrc2api",
version=__version__,
description="LimeSurvey RC2 API Web Services Client",
+ long_description=open("README.md", "r").read(),
+ long_description_content_type="text/markdown",
url="https://github.com/lindsay-stevens",
author="Lindsay Stevens",
author_email="lindsay.stevens.au@gmail.com",
- packages=["limesurveyrc2api"],
+ packages=find_packages(exclude=["tests", "tests.*"]),
test_suite="tests",
include_package_data=True,
license="MIT",
install_requires=[
- # see requirements.txt
+ "requests==2.28.2",
],
keywords="limesurvey api webservice client",
classifiers=[
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
- "Programming Language :: Python :: 3.5",
+ "Programming Language :: Python :: 3.9",
],
)