Skip to main content

Matplotlib-based canvas that allows line drawing and coordinate retrieval

Project description

Coordinate Canvas

Interactive canvas that allows you to draw 2D coordinates in a plane and output their corresponding coordinates to a JSON file.

[!NOTE] All instructions in this README assume your Python 3.11.6+ installation is in your PATH and is aliased under python. If this is not the case, you will need to replace python with the alias or path that points to the correct Python executable.

Installation

python -m pip install coordinate-canvas  # Use dash instead of underscore!

Usage

You can display the help message by running the following command:

python -m coordinate_canvas --help  # Use underscore instead of dash!

Once the canvas has been opened, you will be able to click on any part of it and add a new coordinate. Lines can be switched using the numeric pad on the keyboard, as explained on the header of the window.

Once you have added all the desired coordinates, just press the "Escape" or "Q" keys or close the window. A JSON file will be generated containing all the coordinates you added. This is how the JSON structure looks like:

{
    "line_1": {
        "x": [
            3.064516129032258,
            5.510752688172044,
            10.45698924731183,
            14.045698924731184,
            ...
        ],
        "y": [
            8.837828837828837,
            13.18015318015318,
            13.126873126873129,
            8.03862803862804,
            ...
        ]
    },
    "line_2": {
        ...
    },
    ...
}

Data retrieval

JSON data can easily be retrieved with a few lines of code.

import json

# Assuming the script is located in the same directory where the program is
#   being executed (if not, modify the path below):
with open("coordinates.json", mode="r", encoding="utf-8") as fp:
    data = json.load(fp)  # Loads all data in a dictionary.

# Ways to retrieve data:
line_1 = data["line_1"]
line_1_x = data["line_1"]["x"]
line_1_y = data["line_1"]["y"]
line_1_xy = [(x, y) for x, y in zip(data["line_1"].values())]  # Recommended!

Contributing

If you are planning on contributing to the repository, take a look at the contribution guidelines.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

coordinate-canvas-1.5.1.tar.gz (44.3 kB view details)

Uploaded Source

Built Distribution

coordinate_canvas-1.5.1-py3-none-any.whl (33.4 kB view details)

Uploaded Python 3

File details

Details for the file coordinate-canvas-1.5.1.tar.gz.

File metadata

  • Download URL: coordinate-canvas-1.5.1.tar.gz
  • Upload date:
  • Size: 44.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for coordinate-canvas-1.5.1.tar.gz
Algorithm Hash digest
SHA256 de46d6dbddc1fd2f09223da230511f8f361d9629e5a68afa34ba2cd34fe39a0b
MD5 30d7657ab53abb1e2ae468de0070353a
BLAKE2b-256 91dc6c125fb3a6b52e3ef0207a184f17fb9da10763c0b99a98a05306be0f796b

See more details on using hashes here.

File details

Details for the file coordinate_canvas-1.5.1-py3-none-any.whl.

File metadata

File hashes

Hashes for coordinate_canvas-1.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 343b2d7a7514b9ec423eaeb9cb5e99009ad18afb286e333b101eb8b036f2b1f7
MD5 de612da9afc59652a6bf7eebd83d3730
BLAKE2b-256 bfcc3570d4f98214faf3c90bcd574d9d7e31bc670f720cd4909e6ea7b3ef4e5e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page