Metadata-Version: 2.1
Name: ntmirror
Version: 1.3.0
Summary: Easily updatable local NCBI taxonomy database copy
Home-page: https://github.com/ggonnella/ntmirror
Author: Giorgio Gonnella
Author-email: gonnella@zbh.uni-hamburg.de
License: ISC
Keywords: ncbi taxonomy database mirror
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries
Description-Content-Type: text/markdown
License-File: LICENSE.txt
License-File: AUTHORS.txt

# NtMirror

NtMirror is a tool for creating and keeping up-to-date a local
mirror of the NCBI Taxonomy database

## Requirements

The software is distributed as a Python 3 package.
The file ``requirements.txt`` lists the required pip modules
(installable using ``pip -r requirements.txt``).

A relational database management system (RDBMS) is required.
NtMirror has been developed and tested using MariaDB as RDBMS.
However, it can be probably used with any RDBMS supported by SqlAlchemy.

Optionally, on MariaDB, the database data loading is performed using the
``mysql`` library and not using SqlAlchemy, since the loading is faster.

## Usage manual

For more information on the use of the software, see the
[user manual](https://github.com/ggonnella/ntmirror/blob/main/docs/user_manual.md).


