feat: Initial version!

billyc · billyc · commit 0b2c0a7b03f9 · 2021-12-01T10:38:39.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,6 @@
+__pycache__
+build/
+dist/
+*.egg-info
+.ipynb_checkpoints
+.build-sentinel
diff --git a/.pylintrc b/.pylintrc
@@ -0,0 +1,23 @@
+
+[MASTER]
+
+ignore = tests
+load-plugins=pylint.extensions.docparams,pylint.extensions.docstyle,pylint.extensions.check_elif
+
+
+[DESIGN]
+
+max-complexity = 10
+
+[FORMAT]
+
+max-line-length = 150
+single-line-if-stmt=no
+expected-line-ending-format=LF
+variable-rgx=[a-z0-9_]{1,30}$
+
+[EXCEPTIONS]
+
+# Exceptions that will emit a warning when being caught. Defaults to
+# "Exception"
+overgeneral-exceptions=Exception
diff --git a/.versionrc b/.versionrc
@@ -0,0 +1,14 @@
+{
+  "packageFiles": [
+    {
+      "filename": "VERSION",
+      "type": "plain-text"
+    }
+  ],
+  "bumpFiles": [
+    {
+      "filename": "VERSION",
+      "type": "plain-text"
+    }
+  ]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+    "python.formatting.provider": "black"
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,3 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
diff --git a/Makefile b/Makefile
@@ -0,0 +1,39 @@
+# --------------------------------------------------
+# standard Makefile preamble
+# see https://tech.davis-hansson.com/p/make/
+SHELL := bash
+.ONESHELL:
+.SHELLFLAGS := -eu -o pipefail -c
+.DELETE_ON_ERROR:
+MAKEFLAGS += --warn-undefined-variables
+MAKEFLAGS += --no-builtin-rules
+
+ifeq ($(origin .RECIPEPREFIX), undefined)
+  $(error Your Make does not support .RECIPEPREFIX. Please use GNU Make 4.0 or later)
+endif
+.RECIPEPREFIX = >
+# --------------------------------------------------
+
+build: .build-sentinel
+
+clean:
+> rm -rf build
+> rm -rf dist
+> rm -f  .build-sentinel
+.PHONY: clean
+
+test:
+> pytest tests/
+.PHONY: test
+
+push: test build
+> twine check dist/*
+> twine upload dist/*
+.PHONY: push
+
+.build-sentinel: $(shell find matsim/*.py) $(shell find docs/*) README.md setup.py
+> rm -rf dist
+> python3 setup.py sdist bdist_wheel
+> twine check dist/*
+> touch $@
+
diff --git a/README.md b/README.md
@@ -0,0 +1,22 @@
+# simwrapper-python-tools
+
+Official python library for working with SimWrapper
+
+SimWrapper is...
+
+## About this library
+
+We are at the very early stages of building this library. The API will change, things will break, and there are certainly bugs. You probably shouldn't use this for anything.
+
+- Our primary goal is to make MATSim play nice with **pandas** and **geopandas**, for data analysis workflows.
+- We have only tested this using Anaconda Python. Only Python 3.x is supported.
+- Currently MATSim network, event, and plans files are supported. Hopefully more will be coming soon.
+- For Geopandas network support, you also need to install `geopandas` and `shapely`.
+- Supports JSON and Protobuf event file formats
+- Can write MATSim files too!
+
+## Quickstart
+
+1. Install using `pip install matsim-tools`
+
+2. In lieu of real documentation, here is some sample code to get you started. Good luck!
diff --git a/VERSION b/VERSION
@@ -0,0 +1 @@
+0.99.0
diff --git a/setup.py b/setup.py
@@ -0,0 +1,35 @@
+import pathlib
+
+from setuptools import setup
+
+# The directory containing this file
+HERE = pathlib.Path(__file__).parent
+
+# The text of the README file
+README = (HERE / "README.md").read_text()
+VERSION = (HERE / "VERSION").read_text()
+
+# This call to setup() does all the work
+setup(
+    version=VERSION,
+    name="simwrapper",
+    description="Python support library for SimWrapper data visualization tool",
+    long_description_content_type="text/markdown",
+    url="https://github.com/simwrapper/simwrapper-python-tools",
+    author="Billy Charlton",
+    author_email="billy@okbecause.com",
+    license="GPLv3",
+    classifiers=[
+        "License :: OSI Approved :: GNU General Public License (GPL)",
+        "Programming Language :: Python :: 3",
+    ],
+    packages=["simwrapper"],
+    scripts=['simwrapper/go-simwrapper.py']
+    install_requires=[
+    ],
+    extras_require = {
+    },
+    tests_require=["assertpy", "pytest"],
+    entry_points={},
+    long_description=README,
+)
diff --git a/simwrapper/__init__.py b/simwrapper/__init__.py
@@ -0,0 +1,5 @@
+#from . import Events, Network, Plans, TripEventHandler, writers
+
+#read_network = Network.read_network
+#event_reader = Events.event_reader
+#plan_reader = Plans.plan_reader
diff --git a/simwrapper/go-simwrapper.py b/simwrapper/go-simwrapper.py
@@ -0,0 +1,4 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+print("SIMWRAPPER!")
diff --git a/simwrapper/mini-file-server.py b/simwrapper/mini-file-server.py
@@ -0,0 +1,127 @@
+#!/usr/bin/env python3
+import argparse
+import os
+import re
+import sys
+
+print("\n-----------------------------------------------------------------")
+print("Serving: " + os.getcwd())
+print("Simwrapper-File-Server: serving with RANGE and CORS (open access)")
+print("-----------------------------------------------------------------\n")
+
+try:
+    # Python3
+    import http.server as SimpleHTTPServer
+    from http.server import SimpleHTTPRequestHandler, test
+
+except ImportError:
+    # Python 2
+    from BaseHTTPServer import HTTPServer, test
+    from SimpleHTTPServer import SimpleHTTPRequestHandler
+
+
+def copy_byte_range(infile, outfile, start=None, stop=None, bufsize=16*1024):
+    '''Like shutil.copyfileobj, but only copy a range of the streams.
+
+    Both start and stop are inclusive.
+    '''
+    if start is not None: infile.seek(start)
+    while 1:
+        to_read = min(bufsize, stop + 1 - infile.tell() if stop else bufsize)
+        buf = infile.read(to_read)
+        if not buf:
+            break
+        outfile.write(buf)
+
+BYTE_RANGE_RE = re.compile(r'bytes=(\d+)-(\d+)?$')
+def parse_byte_range(byte_range):
+    '''Returns the two numbers in 'bytes=123-456' or throws ValueError.
+
+    The last number or both numbers may be None.
+    '''
+    if byte_range.strip() == '':
+        return None, None
+
+    m = BYTE_RANGE_RE.match(byte_range)
+    if not m:
+        raise ValueError('Invalid byte range %s' % byte_range)
+
+    first, last = [x and int(x) for x in m.groups()]
+    if last and last < first:
+        raise ValueError('Invalid byte range %s' % byte_range)
+    return first, last
+
+class RangeRequestHandler(SimpleHTTPRequestHandler):
+    """Adds support for HTTP 'Range' requests to SimpleHTTPRequestHandler
+
+    The approach is to:
+    - Override send_head to look for 'Range' and respond appropriately.
+    - Override copyfile to only transmit a range when requested.
+    """
+    def send_head(self):
+        if 'Range' not in self.headers:
+            self.range = None
+            return SimpleHTTPRequestHandler.send_head(self)
+        try:
+            self.range = parse_byte_range(self.headers['Range'])
+        except ValueError as e:
+            self.send_error(400, 'Invalid byte range')
+            return None
+        first, last = self.range
+
+        # Mirroring SimpleHTTPServer.py here
+        path = self.translate_path(self.path)
+        f = None
+        ctype = self.guess_type(path)
+        try:
+            f = open(path, 'rb')
+        except IOError:
+            self.send_error(404, 'File not found')
+            return None
+
+        fs = os.fstat(f.fileno())
+        file_len = fs[6]
+        if first >= file_len:
+            self.send_error(416, 'Requested Range Not Satisfiable')
+            return None
+
+        self.send_response(206)
+        self.send_header('Content-type', ctype)
+
+        if last is None or last >= file_len:
+            last = file_len - 1
+        response_length = last - first + 1
+
+        self.send_header('Content-Range', 'bytes %s-%s/%s' % (first, last, file_len))
+        self.send_header('Content-Length', str(response_length))
+        self.send_header('Last-Modified', self.date_time_string(fs.st_mtime))
+        self.end_headers()
+        return f
+
+    def copyfile(self, source, outputfile):
+        if not self.range:
+            return SimpleHTTPRequestHandler.copyfile(self, source, outputfile)
+
+        # SimpleHTTPRequestHandler uses shutil.copyfileobj, which doesn't let
+        # you stop the copying before the end of the file.
+        start, stop = self.range  # set in send_head()
+        copy_byte_range(source, outputfile, start, stop)
+
+    def end_headers(self):
+        self.send_header("Access-Control-Allow-Origin", "*")
+        self.send_header("Access-Control-Allow-Headers", "Accept-Ranges,Range,*")
+        self.send_header("Access-Control-Max-Age", "86400")
+        self.send_header("Access-Control-Allow-Methods", "GET,OPTIONS,HEAD")
+        self.send_header("Cache-Control", "no-cache, max-age=0, must-revalidate, no-store")
+        self.send_header('Accept-Ranges', 'bytes')
+
+        SimpleHTTPRequestHandler.end_headers(self)
+
+    def do_OPTIONS(self):
+        self.send_response(200)
+        self.end_headers()
+        return None
+
+
+test(HandlerClass=RangeRequestHandler) # , port=args.port)
+
diff --git a/tests/__init__.py b/tests/__init__.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "python.formatting.provider": "black"`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Changelog`
	`2`	`+`
	`3`	`+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.`