Welcome to mapscookiegettercli’s documentation!

Contents:

mapscookiegettercli

  • POSSIBLY DEPRECATED SINCE THERE ARE REPORTS OF GOOGLE BLOCKING THIS. SEE #1

A tool to retreive the cookies from a google authentication process towards the google maps service to be used with locationsharinglib.

Development Workflow

The workflow supports the following steps

  • lint
  • test
  • build
  • document
  • upload
  • graph

These actions are supported out of the box by the corresponding scripts under _CI/scripts directory with sane defaults based on best practices. Sourcing setup_aliases.ps1 for windows powershell or setup_aliases.sh in bash on Mac or Linux will provide with handy aliases for the shell of all those commands prepended with an underscore.

The bootstrap script creates a .venv directory inside the project directory hosting the virtual environment. It uses pipenv for that. It is called by all other scripts before they do anything. So one could simple start by calling _lint and that would set up everything before it tried to actually lint the project

Once the code is ready to be delivered the _tag script should be called accepting one of three arguments, patch, minor, major following the semantic versioning scheme. So for the initial delivery one would call

$ _tag –minor

which would bump the version of the project to 0.1.0 tag it in git and do a push and also ask for the change and automagically update HISTORY.rst with the version and the change provided.

So the full workflow after git is initialized is:

  • repeat as necessary (of course it could be test - code - lint :) ) * code * lint * test
  • commit and push
  • develop more through the code-lint-test cycle
  • tag (with the appropriate argument)
  • build
  • upload (if you want to host your package in pypi)
  • document (of course this could be run at any point)

Important Information

This template is based on pipenv. In order to be compatible with requirements.txt so the actual created package can be used by any part of the existing python ecosystem some hacks were needed. So when building a package out of this do not simple call

$ python setup.py sdist bdist_egg

as this will produce an unusable artifact with files missing. Instead use the provided build and upload scripts that create all the necessary files in the artifact.

Project Features

  • Successfully detects and uses Firefox and Chrome in Mac (latest version tested), Linux (Ubuntu 18.04 with budgie desktop tested) and Windows 7

  • Todo:

    Test Internet explorer and Edge on Windows and test windows 8 and 10.

    Extend error handling for all environments.

Installation

At the command line:

$ pip install mapscookiegettercli

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv mapscookiegettercli
$ pip install mapscookiegettercli

Or, if you are using pipenv:

$ pipenv install mapscookiegettercli

Or, if you are using pipx:

$ pipx install mapscookiegettercli

Usage

To develop on mapscookiegettercli:

# The following commands require pipenv as a dependency

# To lint the project
_CI/scripts/lint.py

# To execute the testing
_CI/scripts/test.py

# To create a graph of the package and dependency tree
_CI/scripts/graph.py

# To build a package of the project under the directory "dist/"
_CI/scripts/build.py

# To see the package version
_CI/scripts/tag.py

# To bump semantic versioning [--major|--minor|--patch]
_CI/scripts/tag.py --major|--minor|--patch

# To upload the project to a pypi repo if user and password are properly provided
_CI/scripts/upload.py

# To build the documentation of the project
_CI/scripts/document.py

To use mapscookiegettercli:

# This tool is written for python3.7
Follow installation procedure from INSTALLATION.srt for your appropriate toolset.


# execute the tool
maps-cookie-getter

# After the full login process the browser should be terminated and a "location_sharing.cookies"
# file should be located at the same location that can be provided to the locationsharinglib.

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Submit Feedback

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.

Get Started!

Ready to contribute? Here’s how to set up mapscookiegettercli for local development. Using of pipenv is highly recommended.

  1. Clone your fork locally:

    $ git clone https://github.com/costastf/mapscookiegettercli

  2. Install your local copy into a virtualenv. Assuming you have pipenv installed, this is how you set up your clone for local development:

    $ cd mapscookiegettercli/
$ pipenv install --ignore-pipfile

  3. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally. Do your development while using the CI capabilities and making sure the code passes lint, test, build and document stages.

  4. Commit your changes and push your branch to the server:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  5. Submit a merge request

mapscookiegettercli

mapscookiegettercli package

Subpackages

mapscookiegettercli.browsers package
Submodules
mapscookiegettercli.browsers.chrome module

chrome package

class mapscookiegettercli.browsers.chrome.Chrome[source]

Bases: object

Bootstraps a chrome selenium driver with the required settings

mapscookiegettercli.browsers.edge module

edge package

class mapscookiegettercli.browsers.edge.Edge[source]

Bases: object

Bootstraps an edge selenium driver with the required settings

mapscookiegettercli.browsers.firefox module

firefox package

class mapscookiegettercli.browsers.firefox.Firefox[source]

Bases: object

Bootstraps a firefox selenium driver with the required settings

mapscookiegettercli.browsers.ie module

ie package

class mapscookiegettercli.browsers.ie.IE[source]

Bases: object

Bootstraps an internet explorer selenium driver with the required settings

Module contents

library package

Import all parts from library here

mapscookiegettercli.library package
Submodules
mapscookiegettercli.library.cookiegetter module

Main code for cookiegetter

class mapscookiegettercli.library.cookiegetter.CookieGetter[source]

Bases: object

Object able to retrieve the cookies from an interactive login session to a google maps service

run(cookie_file_name='location_sharing.cookies')[source]

Executes the process and saves the cookies

Parameters:cookie_file_name (str) – The path and name of the exported cookie file

Returns:

Module contents

library package

Import all parts from library here

Submodules

mapscookiegettercli.mapscookiegettercli module

Main code for mapscookiegettercli

mapscookiegettercli.mapscookiegettercli.get_arguments()[source]

Gets us the cli arguments.

Returns the args as parsed from the argsparser.

mapscookiegettercli.mapscookiegettercli.main()[source]

Main method.

This method holds what you want to execute when the script is run on command line.

mapscookiegettercli.mapscookiegettercliexceptions module

Custom exception code for mapscookiegettercli

exception mapscookiegettercli.mapscookiegettercliexceptions.UnsupportedDefaultBrowser[source]

Bases: Exception

The browser could not be identified or is not supported.

exception mapscookiegettercli.mapscookiegettercliexceptions.UnsupportedOS[source]

Bases: Exception

The os identified is not a supported one.

Module contents

mapscookiegettercli package

Import all parts from mapscookiegettercli here

Credits

Development Lead

History

0.0.1 (04-03-2019)

  • First code creation

0.1.0 (25-03-2019)

  • Initial implementation working for firefox and chrome tested lightly on Mac, Ubuntu 18.04 and Windows 7

0.1.1 (28-03-2019)

  • Removed fstring instance so python3.7 is not a hard requirement

0.2.0 (16-06-2019)

Indices and tables