Giter Site home page Giter Site logo

Comments (2)

nexushoratio avatar nexushoratio commented on August 23, 2024

Due to #13 , the following output does not includes the codes-* commands.

Old help output, both initial, then for each command:

usage: ingress [-h] [-L {debug,info,warning,error}] <command> ...

Perform a number of Ingress related functions.

Global flags:
  -h, --help
  -L {debug,info,warning,error}, --loglevel {debug,info,warning,error}
                        Log level

Commands:
  For more details: ingress <command> --help

  <command>             <command description>
    import              Update the database with portals listed in a bookmarks
                        file.
    unimport            Remove portals listed in a bookmarks file from the
                        database.
    export              Export all portals as a bookmarks file.
    flatten             Load portals from BOOKMARKS and write out as lists
                        using PATTERN.
    find-missing-labels
                        Look through globs of bookmarks for missing labels. It
                        will remove portals with missing labels from the
                        bookmarks and add them to a newly created bookmarks
                        file instead. The contents of the destination
                        bookmarks file will be destroyed.
    merge-bookmarks     Merge multiple bookmarks files into one. Inputs will
                        be the files specified by the glob arguments. The
                        contents of the destination bookmarks file will be
                        destroyed.
    update              Update the locations and directions for portals in a
                        bookmarks file.
    bounds              Create a drawtools file outlining portals in multiple
                        bookmarks files.
    trim                Trim a bookmarks file to only include portals inside a
                        bounds.
    cluster             Find clusters of portals together and save the
                        results. The clustering results are saved into
                        FILENAME.
    make-donuts         Automatically group portals into COUNT sized bookmarks
                        files. The idea is to provide a series of bookmarks
                        that would be suitably sized groups for efficient
                        capturing. Given a starting marker specified in the
                        drawtools file, a circle (donut hole) that includes
                        COUNT portals will be created. The size of this hole
                        will inform the size of concentric rings (donuts). The
                        donut will be broken down into bites that contain
                        roughly COUNT portals. The command will try to balance
                        between between the number of portals in a bite and
                        how big (in area) a bite would be. For example, it
                        will try to avoid having a bite be the entire donut
                        because it reaches out to a sparsely populated area.
    clean-json          Clean and format a json file.
    show-portals        Show portals sorted by date. They will be exported to
                        a bookmarks file.
    routes              Calculate an optimal route between portals listed in a
                        bookmarks file.

usage: ingress import [-h] -b BOOKMARKS

Update the database with portals listed in a bookmarks file.

options:
  -h, --help            show this help message and exit
  -b BOOKMARKS, --bookmarks BOOKMARKS
                        IITC bookmarks json file to use

usage: ingress unimport [-h] -b BOOKMARKS

Remove portals listed in a bookmarks file from the database.

options:
  -h, --help            show this help message and exit
  -b BOOKMARKS, --bookmarks BOOKMARKS
                        IITC bookmarks json file to use

usage: ingress export [-h] -b BOOKMARKS [-s SAMPLES]

Export all portals as a bookmarks file.

options:
  -h, --help            show this help message and exit
  -b BOOKMARKS, --bookmarks BOOKMARKS
                        IITC bookmarks json file to use
  -s SAMPLES, --samples SAMPLES
                        Roughly how many portals should be in the output.

usage: ingress flatten [-h] -b BOOKMARKS [-s SIZE] [-p PATTERN]

Load portals from BOOKMARKS and write out as lists using PATTERN.

options:
  -h, --help            show this help message and exit
  -b BOOKMARKS, --bookmarks BOOKMARKS
                        IITC bookmarks json file to use
  -s SIZE, --size SIZE  Rough upper limit on the size of each flattened output
                        file.
  -p PATTERN, --pattern PATTERN
                        Pattern used to name the output files. Uses PEP 3101
                        formatting strings with the following fields: size,
                        width, count

usage: ingress find-missing-labels [-h] -b BOOKMARKS -g GLOB

Look through globs of bookmarks for missing labels. It will remove portals
with missing labels from the bookmarks and add them to a newly created
bookmarks file instead. The contents of the destination bookmarks file will be
destroyed.

options:
  -h, --help            show this help message and exit
  -b BOOKMARKS, --bookmarks BOOKMARKS
                        IITC bookmarks json file to use
  -g GLOB, --glob GLOB  A filename glob that will be matched by the program
                        instead of the shell. May be specified multiple times.

usage: ingress merge-bookmarks [-h] -b BOOKMARKS -g GLOB

Merge multiple bookmarks files into one. Inputs will be the files specified by
the glob arguments. The contents of the destination bookmarks file will be
destroyed.

options:
  -h, --help            show this help message and exit
  -b BOOKMARKS, --bookmarks BOOKMARKS
                        IITC bookmarks json file to use
  -g GLOB, --glob GLOB  A filename glob that will be matched by the program
                        instead of the shell. May be specified multiple times.

usage: ingress update [-h] -b BOOKMARKS [--noaddresses] [--addresses]
                      [--nodirections] [--directions]

Update the locations and directions for portals in a bookmarks file.

options:
  -h, --help            show this help message and exit
  -b BOOKMARKS, --bookmarks BOOKMARKS
                        IITC bookmarks json file to use
  --noaddresses         Disable updating addresses.
  --addresses           Enable updating addresses.
  --nodirections        Disable updating directions.
  --directions          Enable updating directions..

usage: ingress bounds [-h] -d DRAWTOOLS -g GLOB

Create a drawtools file outlining portals in multiple bookmarks files.

options:
  -h, --help            show this help message and exit
  -d DRAWTOOLS, --drawtools DRAWTOOLS
                        IITC drawtools json file to use
  -g GLOB, --glob GLOB  A filename glob that will be matched by the program
                        instead of the shell. May be specified multiple times.

usage: ingress trim [-h] -b BOOKMARKS -d DRAWTOOLS

Trim a bookmarks file to only include portals inside a bounds.

options:
  -h, --help            show this help message and exit
  -b BOOKMARKS, --bookmarks BOOKMARKS
                        IITC bookmarks json file to use
  -d DRAWTOOLS, --drawtools DRAWTOOLS
                        IITC drawtools json file to use

usage: ingress cluster [-h] -f FILENAME

Find clusters of portals together and save the results. The clustering results
are saved into FILENAME.

options:
  -h, --help            show this help message and exit
  -f FILENAME, --filename FILENAME
                        Any arbitrary file argument.

usage: ingress make-donuts [-h] -d DRAWTOOLS -s SIZE [-b BITES] [-p PATTERN]

Automatically group portals into COUNT sized bookmarks files. The idea is to
provide a series of bookmarks that would be suitably sized groups for
efficient capturing. Given a starting marker specified in the drawtools file,
a circle (donut hole) that includes COUNT portals will be created. The size of
this hole will inform the size of concentric rings (donuts). The donut will be
broken down into bites that contain roughly COUNT portals. The command will
try to balance between between the number of portals in a bite and how big (in
area) a bite would be. For example, it will try to avoid having a bite be the
entire donut because it reaches out to a sparsely populated area.

options:
  -h, --help            show this help message and exit
  -d DRAWTOOLS, --drawtools DRAWTOOLS
                        IITC drawtools json file to use
  -s SIZE, --size SIZE  Number of portals per bite.
  -b BITES, --bites BITES
                        Limit the number of bites.
  -p PATTERN, --pattern PATTERN
                        Pattern used to name the output files. Uses PEP 3101
                        formatting strings with the following fields: size,
                        width, bite

usage: ingress clean-json [-h] -f FILENAME

Clean and format a json file.

options:
  -h, --help            show this help message and exit
  -f FILENAME, --filename FILENAME
                        Any arbitrary file argument.

usage: ingress show-portals [-h] -b BOOKMARKS -f {first_seen,last_seen}
                            [-s START] [-S STOP] [-o {ascend,descend}]
                            [-g {code,date}]

Show portals sorted by date. They will be exported to a bookmarks file.

options:
  -h, --help            show this help message and exit
  -b BOOKMARKS, --bookmarks BOOKMARKS
                        IITC bookmarks json file to use
  -f {first_seen,last_seen}, --field {first_seen,last_seen}
                        Sort on this field.
  -s START, --start START
                        Start date.
  -S STOP, --stop STOP  Stop date.
  -o {ascend,descend}, --order {ascend,descend}
                        Sort order.
  -g {code,date}, --group-by {code,date}
                        How to group text output. Grouping by date will group
                        all of those on the same calendar date.

usage: ingress routes [-h] -b BOOKMARKS [-w WALK_AUTO]

Calculate an optimal route between portals listed in a bookmarks file.

options:
  -h, --help            show this help message and exit
  -b BOOKMARKS, --bookmarks BOOKMARKS
                        IITC bookmarks json file to use
  -w WALK_AUTO, --walk-auto WALK_AUTO
                        Longest walk time to automatically accept.

from ingress.

nexushoratio avatar nexushoratio commented on August 23, 2024

And similar output once migrated to the new API. Since command names default to the function names, some are different. Some explicitly renamed, some just because the original function name is shorter than the old command name.

usage: ingress [-h] [-L {debug,info,warning,error,critical}] <command> ...

Global flags:
  -h, --help
  -L {debug,info,warning,error,critical}, --log-level {debug,info,warning,error,critical}
                        Minimal log level

Commands:
  For more details: ingress <command> --help

  <command>             <command description>
    ingest              Update the database with portals listed in a bookmarks
                        file.
    expunge             Remove portals listed in a bookmarks file from the
                        database.
    export              Export all portals as a bookmarks file.
    flatten             Load portals from BOOKMARKS and write out as lists
                        using PATTERN.
    find-missing-labels
                        Look through globs of bookmarks for missing labels.
    merge               Merge multiple bookmarks files into one.
    update              Update the locations and directions for portals in a
                        bookmarks file.
    bounds              Create a drawtools file outlining portals in multiple
                        bookmarks files.
    trim                Trim a bookmarks file to only include portals inside a
                        boundary.
    cluster             Find clusters of portals together and save the
                        results.
    donuts              Automatically group portals into COUNT sized bookmarks
                        files.
    clean               Clean and format a json file.
    show                Show portals sorted by date.
    route               Calculate an optimal route between portals listed in a
                        bookmarks file.

usage: ingress ingest [-h] -b BOOKMARKS

Update the database with portals listed in a bookmarks file.

options:
  -h, --help            show this help message and exit
  -b BOOKMARKS, --bookmarks BOOKMARKS
                        IITC bookmarks json file to use

usage: ingress expunge [-h] -b BOOKMARKS

Remove portals listed in a bookmarks file from the database.

options:
  -h, --help            show this help message and exit
  -b BOOKMARKS, --bookmarks BOOKMARKS
                        IITC bookmarks json file to use

usage: ingress export [-h] -b BOOKMARKS [-s SAMPLES]

Export all portals as a bookmarks file.

options:
  -h, --help            show this help message and exit
  -b BOOKMARKS, --bookmarks BOOKMARKS
                        IITC bookmarks json file to use
  -s SAMPLES, --samples SAMPLES
                        Roughly how many portals should be in the output.

usage: ingress flatten [-h] -b BOOKMARKS [-s SIZE] [-p PATTERN]

Load portals from BOOKMARKS and write out as lists using PATTERN.

options:
  -h, --help            show this help message and exit
  -b BOOKMARKS, --bookmarks BOOKMARKS
                        IITC bookmarks json file to use
  -s SIZE, --size SIZE  Rough upper limit on the size of each flattened output
                        file.
  -p PATTERN, --pattern PATTERN
                        Pattern used to name the output files. Uses PEP 3101
                        formatting strings with the following fields: size,
                        width, count

usage: ingress find-missing-labels [-h] -b BOOKMARKS -g GLOB

Look through globs of bookmarks for missing labels.

It will remove portals with missing labels from the bookmarks and add them to a
newly created bookmarks file instead.  The contents of the destination bookmarks
file will be destroyed.

options:
  -h, --help            show this help message and exit
  -b BOOKMARKS, --bookmarks BOOKMARKS
                        IITC bookmarks json file to use
  -g GLOB, --glob GLOB  A filename glob that will be matched by the program
                        instead of the shell. May be specified multiple times.

usage: ingress merge [-h] -b BOOKMARKS -g GLOB

Merge multiple bookmarks files into one.

Inputs will be the files specified by the glob arguments.  The contents of the
destination bookmarks file will be destroyed.

options:
  -h, --help            show this help message and exit
  -b BOOKMARKS, --bookmarks BOOKMARKS
                        IITC bookmarks json file to use
  -g GLOB, --glob GLOB  A filename glob that will be matched by the program
                        instead of the shell. May be specified multiple times.

usage: ingress update [-h] -b BOOKMARKS [--noaddresses] [--addresses]
                      [--nodirections] [--directions]

Update the locations and directions for portals in a bookmarks file.

options:
  -h, --help            show this help message and exit
  -b BOOKMARKS, --bookmarks BOOKMARKS
                        IITC bookmarks json file to use
  --noaddresses         Disable updating addresses.
  --addresses           Enable updating addresses.
  --nodirections        Disable updating directions.
  --directions          Enable updating directions..

usage: ingress bounds [-h] -d DRAWTOOLS -g GLOB

Create a drawtools file outlining portals in multiple bookmarks files.

options:
  -h, --help            show this help message and exit
  -d DRAWTOOLS, --drawtools DRAWTOOLS
                        IITC drawtools json file to use
  -g GLOB, --glob GLOB  A filename glob that will be matched by the program
                        instead of the shell. May be specified multiple times.

usage: ingress trim [-h] -b BOOKMARKS -d DRAWTOOLS

Trim a bookmarks file to only include portals inside a boundary.

options:
  -h, --help            show this help message and exit
  -b BOOKMARKS, --bookmarks BOOKMARKS
                        IITC bookmarks json file to use
  -d DRAWTOOLS, --drawtools DRAWTOOLS
                        IITC drawtools json file to use

usage: ingress cluster [-h] -f FILENAME

Find clusters of portals together and save the results.

The clustering results are saved into FILENAME.

options:
  -h, --help            show this help message and exit
  -f FILENAME, --filename FILENAME
                        Any arbitrary file argument.

usage: ingress donuts [-h] -d DRAWTOOLS -s SIZE [-b BITES] [-p PATTERN]

Automatically group portals into COUNT sized bookmarks files.

The idea is to provide a series of bookmarks that would be suitably sized groups
for efficient capturing.

Given a starting marker specified in the drawtools file, a circle (donut hole)
that includes COUNT portals will be created.  The size of this hole will inform
the size of concentric rings (donuts).

The donut will be broken down into bites that contain roughly COUNT portals.
The command will try to balance between between the number of portals in a bite
and how big (in area) a bite would be.  For example, it will try to avoid having
a bite be the entire donut because it reaches out to a sparsely populated area.

options:
  -h, --help            show this help message and exit
  -d DRAWTOOLS, --drawtools DRAWTOOLS
                        IITC drawtools json file to use
  -s SIZE, --size SIZE  Number of portals per bite.
  -b BITES, --bites BITES
                        Limit the number of bites.
  -p PATTERN, --pattern PATTERN
                        Pattern used to name the output files. Uses PEP 3101
                        formatting strings with the following fields: size,
                        width, bite

usage: ingress clean [-h] -f FILENAME

Clean and format a json file.

options:
  -h, --help            show this help message and exit
  -f FILENAME, --filename FILENAME
                        Any arbitrary file argument.

usage: ingress show [-h] -b BOOKMARKS -f {first_seen,last_seen} [-s START]
                    [-S STOP] [-o {ascend,descend}] [-g {code,date}]

Show portals sorted by date.

They will be exported to a bookmarks file.

options:
  -h, --help            show this help message and exit
  -b BOOKMARKS, --bookmarks BOOKMARKS
                        IITC bookmarks json file to use
  -f {first_seen,last_seen}, --field {first_seen,last_seen}
                        Sort on this field.
  -s START, --start START
                        Start date.
  -S STOP, --stop STOP  Stop date.
  -o {ascend,descend}, --order {ascend,descend}
                        Sort order.
  -g {code,date}, --group-by {code,date}
                        How to group text output. Grouping by date will group
                        all of those on the same calendar date.

usage: ingress route [-h] -b BOOKMARKS [-w WALK_AUTO]

Calculate an optimal route between portals listed in a bookmarks file.

options:
  -h, --help            show this help message and exit
  -b BOOKMARKS, --bookmarks BOOKMARKS
                        IITC bookmarks json file to use
  -w WALK_AUTO, --walk-auto WALK_AUTO
                        Longest walk time to automatically accept.

from ingress.

Related Issues (19)

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.