Metadata-Version: 2.1
Name: nftools
Version: 1.0.7
Summary: A CLI for managing your solana nft collection.
Home-page: https://github.com/akajimeagle/nftools
Author: Jim Eagle
Author-email: akajimeagle@pm.me
License: MIT license
Keywords: nftools
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.7
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: click (~=8.1.3)
Requires-Dist: aiohttp (~=3.8.1)
Requires-Dist: base58 (~=2.1.1)
Requires-Dist: pandas (~=1.3.5)
Requires-Dist: requests (~=2.28.1)
Requires-Dist: setuptools (~=60.2.0)
Requires-Dist: tqdm (==4.64.0)

=======
nftools
=======


.. image:: https://img.shields.io/pypi/v/nftools.svg
        :target: https://pypi.python.org/pypi/nftools

.. image:: https://img.shields.io/travis/akajimeagle/nftools.svg
        :target: https://travis-ci.com/akajimeagle/nftools

.. image:: https://readthedocs.org/projects/nftools/badge/?version=latest
        :target: https://nftools.readthedocs.io/en/latest/?version=latest
        :alt: Documentation Status

A CLI for managing your solana nft collection.


* Free software: MIT license


Requirements
-------------

- `python3.7`_ installed.

.. _python3.7: https://www.python.org/downloads/

- `solana-cli-tools`_ installed.

.. _solana-cli-tools: https://docs.solana.com/cli/install-solana-cli-tools

- `spl-token-cli`_ installed.

.. _spl-token-cli: https://spl.solana.com/token


Getting Started
----------------
With requirements installed, and python3.7 active and on path (or in virtual environment):

- Install nftools: `pip install nftools`
- Verify installation: `nftools --version`
    - If successful, should output `nftools, version 1.0.6`
- View available methods: `nftools --help`
- Run your first command: `nftools snapshot`



READY
------


Create Whitelist Token
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Create whitelist token (0 decimals) and mint specified amount to your wallet.*

::

$ nftools create-whitelist-token


Take Holder Snapshot
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Take snapshot of active holders for specified collection.
Captures wallet address, nft token address, and nft token account address.
Save in your specified format (json, csv, xlsx)*

::

$ nftools snapshot


Get Hash List
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Get list of nft token addresses for specified collection. Save in your specified format (json, csv, xlsx)*

::

$ nftools get-hash-list


Get Collection NFts Held
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Get # of collection NFTs held by owner. Save in your specified format (json, csv, xlsx)*

::

$ nftools get-holders


WIP
-------


Get Collection Metadata
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::

$ nftools get-metadata


TODO
-------


Collection Airdrop
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::

$ nftools airdrop-collection


=======
History
=======

0.1.0 (2022-08-14)
------------------

* First release on PyPI.


