Giter Club home page Giter Club logo

py_mac_io's Introduction

PyMacIO

Interface with the macaddress.io API

Note: there is a '5 minute' script version in ./script that I would write for myself in a time crunch

Configuration

The macaddress.io API key is stored in an environment file (or optionally as an environment variable)

  1. Create your configuration file
    1. cp .env.local .env
  2. Add your macaddress.io api key where indicated in the sample file
  3. The API url is predefined and should not need to be changed

You can also set the following environment variables:

  • MACIO_API_KEY
  • MACIO_API_URL

Run from Docker image

  1. Navigate to project root
  2. docker build -t pymacio .
  3. Run pymacio (using example address 00:00:00:00:00:00)
    1. See usage: docker run pymacio -h
    2. Query company name: docker run pymacio 00:00:00:00:00:00
    3. Dump entire JSON response: docker run pymacio --full 00:00:00:00:00:00
    4. Accepts address with colons, dashes or no delimiter

Running locally

  1. Install Python (>=3.9.6)
  2. Install curl
    1. Examples
      1. Linux: apt-get install curl
      2. MacOS: brew install curl
  3. Install poetry 1.3.2 and add to path
    1. curl -sSL https://install.python-poetry.org | python - --version 1.3.2
    2. export PATH="$POETRY_HOME/bin:$PATH"
  4. Run the app
    1. Install dependencies
      1. poetry install --no-root
    2. See usage: poetry run pymacio -h
    3. Query company name: poetry run pymacio 00:00:00:00:00:00
    4. Dump entire JSON response: poetry run pymacio --full 00:00:00:00:00:00

py_mac_io's People

Contributors

anthonypdawson avatar

Watchers

 avatar  avatar

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.