Merge pull request #16 from lindsay-stevens/update-packaging

Update packaging

.github/workflows/build.yml

@@ -0,0 +1,50 @@
+name: Build
+
+on: [push, pull_request]
+
+jobs:
+
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ['3.9']
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+
+      # Install dependencies.
+      - uses: actions/cache@v3
+        name: Python cache with dependencies.
+        id: python-cache
+        with:
+          path: ${{ env.pythonLocation }}
+          key: ${{ env.pythonLocation }}-${{ matrix.os }}-${{ matrix.python }}-${{ hashFiles('setup.py') }}-${{ hashFiles('dev_requirements.pip') }}
+      - name: Install dependencies.
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r dev_requirements.pip
+          pip list
+
+      # Build and Upload.
+      - name: Build sdist and wheel.
+        run: |
+          pip install wheel
+          rm -rf build dist *.egg-info
+          python setup.py sdist bdist_wheel
+      # Check.
+      - name: Check dist with twine
+        run: |
+          pip install twine
+          twine check dist/*
+      - name: Upload sdist and wheel.
+        if: success()
+        uses: actions/upload-artifact@v3
+        with:
+          name: limesurveyrc2api--on-${{ matrix.os }}--py${{ matrix.python }}
+          path: ${{ github.workspace }}/dist/limesurveyrc2api*

.gitignore

@@ -1,69 +1,15 @@
+# Common editing files.
 *.pyc
-__pycache__
-dist/
-build/
-*.egg-info/
+*.swp
+.DS_Store
+.idea
+*.iml
+.vscode
+
+# Folders created by setuptools.
+build
+dist
+*.egg-info
+
+# Pypi manifest.
 MANIFEST
-
-# config files as they usually contain confidential information
-*.ini
-
-# Seems to be a user-specific config directory, with path to the project SDK (python interpreter)
-.idea/**/misc.xml
-
-
-
-
-# If using IntelliJ, ignore all the things
-# Add project-specific ignores above, below is copied from:
-# https://github.com/github/gitignore/blob/master/Global/JetBrains.gitignore
-
-# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
-# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
-
-# User-specific stuff:
-.idea/**/workspace.xml
-.idea/**/tasks.xml
-.idea/dictionaries
-
-# Sensitive or high-churn files:
-.idea/**/dataSources/
-.idea/**/dataSources.ids
-.idea/**/dataSources.xml
-.idea/**/dataSources.local.xml
-.idea/**/sqlDataSources.xml
-.idea/**/dynamic.xml
-.idea/**/uiDesigner.xml
-
-# Gradle:
-.idea/**/gradle.xml
-.idea/**/libraries
-
-# CMake
-cmake-build-debug/
-
-# Mongo Explorer plugin:
-.idea/**/mongoSettings.xml
-
-## File-based project format:
-*.iws
-
-## Plugin-specific files:
-
-# IntelliJ
-out/
-
-# mpeltonen/sbt-idea plugin
-.idea_modules/
-
-# JIRA plugin
-atlassian-ide-plugin.xml
-
-# Cursive Clojure plugin
-.idea/replstate.xml
-
-# Crashlytics plugin (for Android Studio and IntelliJ)
-com_crashlytics_export_strings.xml
-crashlytics.properties
-crashlytics-build.properties
-fabric.properties

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

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
 

dev_requirements.pip

@@ -0,0 +1,2 @@
+-e .
+aiosmtpd==1.0.0

limesurveyrc2api/__init__.py

@@ -1 +1 @@
-__version__ = "2017.1"
+__version__ = "2.0.0"

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="[email protected]",
-    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",
     ],
 )