v2.0

readme.md

@@ -4,6 +4,7 @@
 [![Build Status](https://travis-ci.org/xoolive/traffic.svg?branch=master)](https://travis-ci.org/xoolive/traffic)
 [![Code Coverage](https://img.shields.io/codecov/c/github/xoolive/traffic.svg)](https://codecov.io/gh/xoolive/traffic) 
 [![Checked with mypy](https://img.shields.io/badge/mypy-checked-blue.svg)](https://mypy.readthedocs.io/)
+![License](https://img.shields.io/pypi/l/traffic.svg)
 
 
 The traffic library helps working with common sources of air traffic data.
@@ -51,6 +52,8 @@ conda install cartopy shapely
 
 ## Documentation
 
+[![Documentation Status](https://readthedocs.org/projects/traffic-viz/badge/?version=latest)](https://traffic-viz.github.io/)
+
 Documentation available at [https://travis-viz.github.io/](https://traffic-viz.github.io/)
 
 ## Command line tool
@@ -76,26 +79,43 @@ More details in the [GUI section of the documentation](https://traffic-viz.githu
 
 ![GUI screenshot](https://raw.githubusercontent.com/xoolive/traffic/master/docs/_static/gui_start.png)
 
-## Frequently asked questions
+## Feedback and contribution
 
-- Something doesn't work. What should I do?
+Any input, feedback, bug report or contribution is welcome.
 
-Please file an [issue](https://github.com/xoolive/traffic/issues/new) but
-activating the `DEBUG` messages first may be helpful:
+Should you encounter any issue, you may want to file it in the [issue](https://github.com/xoolive/traffic/issues/new) section of this repository. Please first activate the `DEBUG` messages recorded using Python logging mechanism with the following snippet:
 
 ```python
 from traffic.core.logging import loglevel
 loglevel('DEBUG')
 ```
 
-- I encountered this issue, here is how to fix it.
+Bug fixes and improvements in the library are also helpful.
+
+If you share a fix together with the issue, I can include it in the code for
+you. But since you did the job, pull requests (PR) let you keep the authorship
+on your additions. For details on creating a PR see GitHub documentation
+[Creating a pull
+request](https://help.github.com/en/articles/creating-a-pull-request). You can
+add more details about your example in the PR such as motivation for the example
+or why you thought it would be a good addition. You will get feed back in the PR
+discussion if anything needs to be changed. To make changes continue to push
+commits made in your local example branch to origin and they will be
+automatically shown in the PR.
+
+You may find the process troublesome but please keep in mind it is actually
+easier that way to keep track of corrections and to remember why things are the
+way they are.
+
+## Frequently asked questions
+
+- I like your work, it is helpful. How should I cite it in my academic paper?
 
-First of all, thank you. All kinds of corrections are welcome.
+A proper publication introducting the library is under preparation. Please come
+back here when you are ready to submit. If it is not ready, a word of
+acknowledgement is appreciated. You may also want to consider starring this
+github repository.
 
-I can include your fix in the code and push it. But since you did the job, you
-may want to file a [PR](https://yangsu.github.io/pull-request-tutorial/) and
-keep the authorship. It is also easier for me to keep track of corrections and
-remember why things are the way they are.
 
 - I want to know more about Eurocontrol NM files
 

setup.py

@@ -18,7 +18,7 @@
 
 setup(
     name="traffic",
-    version="2.0b0",
+    version="2.0",
     author="Xavier Olive",
     author_email="git@xoolive.org",
     url="https://github.com/xoolive/traffic/",
@@ -73,10 +73,16 @@
         #   3 - Alpha
         #   4 - Beta
         #   5 - Production/Stable
-        "Development Status :: 3 - Alpha",
+        "Development Status :: 4 - Beta",
         # Indicate who your project is intended for
-        "Intended Audience :: Developers",
-        "Topic :: Software Development :: Build Tools",
+        "Intended Audience :: Information Technology",
+        "Intended Audience :: Science/Research",
+        # Indicate relevant topics
+        "Topic :: Scientific/Engineering :: Artificial Intelligence",
+        "Topic :: Scientific/Engineering :: GIS",
+        "Topic :: Scientific/Engineering :: Information Analysis",
+        "Topic :: Scientific/Engineering :: Visualization",
+        "Topic :: Software Development :: Libraries",
         # Pick your license as you wish (should match "license" above)
         "License :: OSI Approved :: MIT License",
         # Specify the Python versions you support here. In particular, ensure
@@ -85,5 +91,6 @@
         "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
+        "Typing :: Typed",
     ],
 )

tests/test_decode.py

@@ -1,16 +1,8 @@
-import sys
 from pathlib import Path
 
 from traffic.core import Flight, Traffic
 from traffic.data import opensky
-from traffic.data.samples import collections, get_flight
-
-
-def get_sample(module, name: str):
-    if sys.version_info >= (3, 7):
-        return getattr(module, name)
-    path = Path(module.__file__).parent
-    return get_flight(name, path)
+from traffic.data.samples import collections, get_sample
 
 
 def long_enough(flight: Flight) -> bool: