Metadata-Version: 2.1
Name: twarc2sql
Version: 1.0.0
Summary: This package converts jsonl file generated by twarc2 to sql database in an opnionated way.
Home-page: https://github.com/unna97/twarc2sql
Author: Unnati Patel
Author-email: unnati97@gmail.com
License: MIT license
Keywords: twarc2sql
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.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.9
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: psycopg2 (==2.9.5)
Requires-Dist: SQLAlchemy (==2.0.7)
Requires-Dist: SQLAlchemy-Utils (==0.40.0)
Requires-Dist: numpy (==1.24.2)
Requires-Dist: pandas (==1.5.3)
Requires-Dist: python-dotenv (==1.0.0)
Provides-Extra: default
Requires-Dist: psycopg2 (==2.9.5) ; extra == 'default'
Requires-Dist: SQLAlchemy (==2.0.7) ; extra == 'default'
Requires-Dist: SQLAlchemy-Utils (==0.40.0) ; extra == 'default'
Requires-Dist: numpy (==1.24.2) ; extra == 'default'
Requires-Dist: pandas (==1.5.3) ; extra == 'default'
Requires-Dist: python-dotenv (==1.0.0) ; extra == 'default'
Provides-Extra: dev
Requires-Dist: pip (==23.1) ; extra == 'dev'
Requires-Dist: bump2version (==1.0.1) ; extra == 'dev'
Requires-Dist: wheel (==0.40.0) ; extra == 'dev'
Requires-Dist: flake8 (==6.0.0) ; extra == 'dev'
Requires-Dist: tox (==4.4.12) ; extra == 'dev'
Requires-Dist: coverage (==7.2.3) ; extra == 'dev'
Requires-Dist: twine (==4.0.2) ; extra == 'dev'
Requires-Dist: ruff (==0.0.261) ; extra == 'dev'
Requires-Dist: pre-commit (==3.2.2) ; extra == 'dev'
Requires-Dist: docformatter (==1.6.0) ; extra == 'dev'
Requires-Dist: docutils (==0.19) ; extra == 'dev'
Requires-Dist: pycodestyle (==2.10.0) ; extra == 'dev'
Requires-Dist: pydocstyle (==6.3.0) ; extra == 'dev'
Requires-Dist: mypy (==1.2.0) ; extra == 'dev'
Requires-Dist: mypy-extensions (==1.0.0) ; extra == 'dev'
Requires-Dist: pytest (==7.3.1) ; extra == 'dev'
Requires-Dist: black (==23.3.0) ; extra == 'dev'
Requires-Dist: typing (==3.7.4.3) ; extra == 'dev'
Requires-Dist: typing-extensions (==4.5.0) ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx (==6.1.3) ; extra == 'docs'
Requires-Dist: numpydoc (==1.5) ; extra == 'docs'
Requires-Dist: pillow (==9.4) ; extra == 'docs'
Requires-Dist: alabaster (==0.7.13) ; extra == 'docs'
Requires-Dist: PyYAML (==6.0) ; extra == 'docs'

=========
twarc2sql
=========

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

.. image:: https://readthedocs.org/projects/twarc2sql/badge/?version=latest
        :target: https://twarc2sql.readthedocs.io/en/latest/?version=latest
        :alt: Documentation Status
.. image:: https://github.com/unna97/twarc2sql/actions/workflows/test.yaml/badge.svg
        :target: https://github.com/unna97/twarc2sql/actions/workflows/test.yaml
        :alt: Tests

This package converts jsonl file generated by twarc2 to sql database in an opnionated way.


* Free software: MIT license
* Documentation: https://twarc2sql.readthedocs.io.


Features
--------

*  This package converts jsonl file generated by twarc2 to a postgres sql database in an opnionated way.
* It creates a database with multiple tables that can be found in the documentation & models.py file.

Installation
------------
You can install twarc2sql using pip:

.. code-block:: console

    $ pip install twarc2sql

Usage
-----

.. code-block:: python

        import twarc2sql

        twarc2sql.connect_to_db_and_upload(
            "folderpath/to/jsonl/file",
            "jsonl_file",
            "twarc_task_type",
            "env_file_with_db_information",
        )


Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


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

0.1.0 (2023-03-23)
------------------

* First release on PyPI.
