Giter VIP home page Giter VIP logo

locomotive's Introduction


Python API clients and a CLI for France's railways ✨

Installation

locomotive requires Python 3.6+ and can be installed using pip:

pip install locomotive

API Clients

Module Features Status
oui_v3 Travel Request oui_v3
gc Board Request oui_v3

CLI

locomotive is easy to use. Find below simple examples:

locomotive search --help
# Search by city name
locomotive search Amsterdam Paris
# Search by train station code (Amsterdam to Paris here)
locomotive search NLAMA FRPAR
# Specify the date and the travel class
locomotive search Brest Paris --date 2019/07/14 --class first

Development

poetry install
poetry run locomotive

# pre-commit
poetry run pre-commit install
poetry run pre-commit run --all-files

Releases

poetry version X.Y.Z # e.g. v0.4.0
git tag vX.Y.Z
git push --tags

Licenses

locomotive is released under the MIT license. The train stations database (stations-lite.csv) is derived from stations.csv (trainline-eu/stations) released under the Open Database License (ODbL) license.

Logo: Train Tickets by b farias from the Noun Project.

locomotive's People

Contributors

maxmouchet avatar yfe404 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Forkers

lucas-c tham-le

locomotive's Issues

Additional features

  • Implement train services (lounge, meals, wifi, ...)
  • Document CLI options (help=...)

Code cleanup

  • Remove passenger store and associated CLI flag (unused feature, may be re-implemented later if needed)
  • Separate offline/online tests (use pytest markers ? http://doc.pytest.org/en/latest/example/markers.html)
  • Separate CLI repo (locomotive-cli ?)
  • Merge mypy and isort config. to pyproject.toml when supported
  • abstract -> base, multiple inheritance for features supported by the clients
  • More tests, increase coverage
  • Change logo (tunnel), update README.md (Julia style)
  • Multithreaded clients
  • Proper date formatting (babel, pendulum, ?)

403 error on search

Hi,

locomotive is currently crashing on basic search with error :
requests.exceptions.HTTPError: 403 Client Error: Forbidden for url: https://wshoraires.oui.sncf/m730/vmd/maq/v3/proposals/train

How to test it :
locomotive search Brest Paris --date 2021/07/14

Any idea why?

Test & document Windows support

  • Does pip install sncf-cli works ?
  • Do tests passes ?
  • Does sncf-cli ... works from Windows commandline ?
  • Document Windows installation/usage in README, if needed

Review README

  • Check for typos
  • Add more information (?)
  • Reorganize sections

Automate carbon image creation

We use carbon.now.sh to create the image in the README.
Can we automate this process ?

The image should contains the following text (or similar):

$ sncf-cli search Lyon Paris
[sncf-cli output, truncated to first proposal]
...

The configuration file from carbon.now.sh is:

{
  "paddingVertical": "45px",
  "paddingHorizontal": "38px",
  "marginVertical": "45px",
  "marginHorizontal": "45px",
  "backgroundImage": null,
  "backgroundImageSelection": null,
  "backgroundMode": "color",
  "backgroundColor": "rgba(239,40,44,0)",
  "dropShadow": true,
  "dropShadowOffsetY": "20px",
  "dropShadowBlurRadius": "27px",
  "theme": "material",
  "windowTheme": "none",
  "language": "text",
  "fontFamily": "Hack",
  "fontSize": "14px",
  "lineHeight": "143%",
  "windowControls": true,
  "widthAdjustment": false,
  "lineNumbers": false,
  "exportSize": "4x",
  "watermark": false,
  "squaredImage": false,
  "loading": false,
  "aspectRatio": 2.1377551020408165,
  "icon": "/static/presets/1.png",
  "isVisible": true
}

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.