Metadata-Version: 2.3
Name: fc-nmap
Version: 0.0.5
Summary: Farcaster network mapping
Project-URL: Documentation, https://github.com/vrypan/fc-nmap#readme
Project-URL: Issues, https://github.com/vrypan/fc-nmap/issues
Project-URL: Source, https://github.com/vrypan/fc-nmap
Author-email: vrypan <vrypan@gmail.comm>
License-Expression: MIT
License-File: LICENSE.txt
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.8
Requires-Dist: click
Requires-Dist: grpcio-tools==1.59.0
Requires-Dist: grpcio==1.59.0
Requires-Dist: ipaddress
Requires-Dist: protobuf==4.24.4
Requires-Dist: requests
Description-Content-Type: text/markdown

# fc-nmap

**THis software is still in alpha and under heavy development.** Things will change and break.

[![PyPI - Version](https://img.shields.io/pypi/v/fc-nmap.svg)](https://pypi.org/project/fc-nmap)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fc-nmap.svg)](https://pypi.org/project/fc-nmap)

-----

## Usage

```console
pip install fc-nmap

fc-nmap --help

Usage: fc-nmap [OPTIONS] COMMAND [ARGS]...

  Farcaster Network Mapper

Options:
  --version   Show the version and exit.
  -h, --help  Show this message and exit.

Commands:
  dumpdb    Create a tab separated dump of the database
  initdb    Initialize the database
  scan      fc-nmap scan will scann the network starting from [HUB] and...
  updatedb  Collect addtional information about each hub
```

`scan` will start from one hub, get its contact list and ask other hubs for their lists. Based on my tests so far, `hops > 10` will make litte difference.
Data collected is stored in a local sqlite3 db.

`updatedb` will collect additiona info. 

`dumpdb` generates a text export.

## License

`fc-nmap` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
