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
Provides-Extra: dev
Provides-Extra: docs
Provides-Extra: default
License-File: LICENSE
License-File: AUTHORS.rst

=========
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.
