Longitude

A new bunch of middleware functions to build applications on top of CARTO.

Roadmap

• Database model

  • CARTO data source
    • Basic parametrized queries (i.e. templated queries)
    • Protected parametrized queries (i.e. avoiding injection)
    • Bind/dynamic parameters in queries (server-side render)
  • Postgres data source
    • psycopg2
    • SQLAlchemy
  • Cache
    • Base cache
      • Put
      • Get
      • Key generation
      • Flush
      • Tests
    • Ram Cache
      • Tests
    • Redis Cache
      • Tests
  • Documentation
    • Sample scripts
  • Unit tests
  • Sample scripts

• Config

• CI PyPi versioning

• COPY operations

  • Carto
    • COPY FROM
    • COPY TO
  • Postgres
    • COPY FROM
    • COPY TO
  • SQLAlchemy
    • COPY FROM
    • COPY TO

• Validations

  • Marshmallow
    • Wrapper (?)
    • Documentation

• Swagger

  • Decorators
  • Flassger (?)
  • OAuth integration
  • Postman integration
  • Documentation

• SQL Alchemy

  • Model definition
  • Jenkins integration
  • Documentation

• OAuth

  • OAuth2 with Carto (onprem)
  • Role mapping
  • Token storage
  • Documentation

As final user...

How to use:

pip install longitude

Or:

pipenv install longitude

Or:

poetry add longitude

Or install from GitHub:

pip install -e git+https://github.com/GeographicaGS/Longitude#egg=longitude

As developer...

First time

1. Install poetry using the recommended process
   1. poetry is installed globally as a tool
   2. It works along with virtualenvironments
2. Create a virtual environment for Python 3.x (check the current development version in pyproject.toml)
   1. You can create it wherever you want but do not put it inside the project
   2. A nice place is $HOME/virtualenvs/longitude
3. Clone the longitude repo
4. cd to the repo and:
   1. Activate the virtual environment: . ~/virtualenvs/longitude/bin/activate
   2. Run poetry install
5. Configure your IDE to use the virtual environment

Daily

1. Remember to activate the virtual environment

Why Poetry?

Because it handles development dependencies and packaging with a single file (pyproject.toml), which is already standard.

Sample scripts

These are intended to be used with real databases (i.e. those in your profile) to check features of the library. They must be run from the virtual environment.

Testing and coverage

The pytest-cov plugin is being used. Coverage configuration is at .coveragerc (including output folder).

You can run something like: pytest --cov-report=html --cov=core core and the results will go in the defined html folder.

There is a bash script called generate_core_coverage.sh that runs the coverage analysis and shows the report in your browser.