folktexts 0.0__tar.gz

folktexts-0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 André Cruz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

folktexts-0.0/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.1
+Name: folktexts
+Version: 0.0
+Summary: A multi-lingual, multi-country Q&A dataset of social facts.
+Author: AndreFCruz
+Project-URL: Homepage, https://github.com/AndreFCruz/folktexts
+Project-URL: Documentation, https://andrefcruz.github.io/folktexts/
+Project-URL: Repository, https://github.com/AndreFCruz/folktexts
+Classifier: Development Status :: 1 - Planning
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+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
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: tqdm
+Provides-Extra: tests
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: coverage; extra == "tests"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx_rtd_theme; extra == "docs"
+Requires-Dist: sphinx-autopackagesummary; extra == "docs"
+Requires-Dist: myst-parser; extra == "docs"
+Requires-Dist: sphinx-copybutton; extra == "docs"
+Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
+Requires-Dist: sphinxemoji; extra == "docs"
+
+# :book: folktexts   <!-- omit in toc -->
+> :construction: Package under construction
+
+![Tests status](https://github.com/AndreFCruz/folktexts/actions/workflows/python-package.yml/badge.svg)
+![PyPI status](https://github.com/AndreFCruz/folktexts/actions/workflows/python-publish.yml/badge.svg)
+![Documentation status](https://github.com/AndreFCruz/folktexts/actions/workflows/python-docs.yml/badge.svg)
+![PyPI version](https://badgen.net/pypi/v/folktexts)
+![OSI license](https://badgen.net/pypi/license/folktexts)
+![Python compatibility](https://badgen.net/pypi/python/folktexts)
+
+Repo to host the `folktexts` project.
+
+Package documentation can be found [here](https://andrefcruz.github.io/folktexts/)!
+
+**Table of contents:**
+- [Installing](#installing)
+- [Usage](#usage)
+- [License and terms of use](#license-and-terms-of-use)
+
+
+## Installing
+
+Install package from [PyPI](https://pypi.org/project/folktexts/):
+
+```
+pip install folktexts
+```
+
+
+## Usage
+
+*TODO*
+
+
+## License and terms of use
+
+*TODO* (data is licensed under CC BY-NC-SA 4.0; `folktexts` code can be licensed under MIT)

folktexts-0.0/README.md

@@ -0,0 +1,37 @@
+# :book: folktexts   <!-- omit in toc -->
+> :construction: Package under construction
+
+![Tests status](https://github.com/AndreFCruz/folktexts/actions/workflows/python-package.yml/badge.svg)
+![PyPI status](https://github.com/AndreFCruz/folktexts/actions/workflows/python-publish.yml/badge.svg)
+![Documentation status](https://github.com/AndreFCruz/folktexts/actions/workflows/python-docs.yml/badge.svg)
+![PyPI version](https://badgen.net/pypi/v/folktexts)
+![OSI license](https://badgen.net/pypi/license/folktexts)
+![Python compatibility](https://badgen.net/pypi/python/folktexts)
+
+Repo to host the `folktexts` project.
+
+Package documentation can be found [here](https://andrefcruz.github.io/folktexts/)!
+
+**Table of contents:**
+- [Installing](#installing)
+- [Usage](#usage)
+- [License and terms of use](#license-and-terms-of-use)
+
+
+## Installing
+
+Install package from [PyPI](https://pypi.org/project/folktexts/):
+
+```
+pip install folktexts
+```
+
+
+## Usage
+
+*TODO*
+
+
+## License and terms of use
+
+*TODO* (data is licensed under CC BY-NC-SA 4.0; `folktexts` code can be licensed under MIT)

folktexts-0.0/folktexts/__init__.py

@@ -0,0 +1 @@
+from ._version import __version__, __version_info__

folktexts-0.0/folktexts/_version.py

@@ -0,0 +1,5 @@
+"""Module to expose version information."""
+from importlib import metadata
+
+__version__ = metadata.version("folktexts")
+__version_info__ = tuple(__version__.split("."))

folktexts-0.0/folktexts.egg-info/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.1
+Name: folktexts
+Version: 0.0
+Summary: A multi-lingual, multi-country Q&A dataset of social facts.
+Author: AndreFCruz
+Project-URL: Homepage, https://github.com/AndreFCruz/folktexts
+Project-URL: Documentation, https://andrefcruz.github.io/folktexts/
+Project-URL: Repository, https://github.com/AndreFCruz/folktexts
+Classifier: Development Status :: 1 - Planning
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+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
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: tqdm
+Provides-Extra: tests
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: coverage; extra == "tests"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx_rtd_theme; extra == "docs"
+Requires-Dist: sphinx-autopackagesummary; extra == "docs"
+Requires-Dist: myst-parser; extra == "docs"
+Requires-Dist: sphinx-copybutton; extra == "docs"
+Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
+Requires-Dist: sphinxemoji; extra == "docs"
+
+# :book: folktexts   <!-- omit in toc -->
+> :construction: Package under construction
+
+![Tests status](https://github.com/AndreFCruz/folktexts/actions/workflows/python-package.yml/badge.svg)
+![PyPI status](https://github.com/AndreFCruz/folktexts/actions/workflows/python-publish.yml/badge.svg)
+![Documentation status](https://github.com/AndreFCruz/folktexts/actions/workflows/python-docs.yml/badge.svg)
+![PyPI version](https://badgen.net/pypi/v/folktexts)
+![OSI license](https://badgen.net/pypi/license/folktexts)
+![Python compatibility](https://badgen.net/pypi/python/folktexts)
+
+Repo to host the `folktexts` project.
+
+Package documentation can be found [here](https://andrefcruz.github.io/folktexts/)!
+
+**Table of contents:**
+- [Installing](#installing)
+- [Usage](#usage)
+- [License and terms of use](#license-and-terms-of-use)
+
+
+## Installing
+
+Install package from [PyPI](https://pypi.org/project/folktexts/):
+
+```
+pip install folktexts
+```
+
+
+## Usage
+
+*TODO*
+
+
+## License and terms of use
+
+*TODO* (data is licensed under CC BY-NC-SA 4.0; `folktexts` code can be licensed under MIT)

folktexts-0.0/folktexts.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+README.md
+pyproject.toml
+folktexts/__init__.py
+folktexts/_version.py
+folktexts.egg-info/PKG-INFO
+folktexts.egg-info/SOURCES.txt
+folktexts.egg-info/dependency_links.txt
+folktexts.egg-info/requires.txt
+folktexts.egg-info/top_level.txt
+requirements/docs.txt
+requirements/main.txt
+requirements/tests.txt
+tests/test_dummy.py

folktexts-0.0/folktexts.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

folktexts-0.0/folktexts.egg-info/requires.txt

@@ -0,0 +1,16 @@
+numpy
+pandas
+tqdm
+
+[docs]
+sphinx
+sphinx_rtd_theme
+sphinx-autopackagesummary
+myst-parser
+sphinx-copybutton
+sphinxcontrib-bibtex
+sphinxemoji
+
+[tests]
+pytest
+coverage

folktexts-0.0/folktexts.egg-info/top_level.txt

@@ -0,0 +1 @@
+folktexts

folktexts-0.0/pyproject.toml

@@ -0,0 +1,96 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "folktexts"
+description = "A multi-lingual, multi-country Q&A dataset of social facts."
+authors = [
+    { name = "AndreFCruz" }
+]
+
+# PyPI classifiers, see https://pypi.org/classifiers/
+classifiers = [
+    "Development Status :: 1 - Planning",
+    "License :: OSI Approved :: MIT License",
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+
+version = "0.0"
+requires-python = ">=3.8"
+dynamic = [
+    "readme",
+    "dependencies",
+    "optional-dependencies",
+]   # these are defined below dynamically
+
+[tool.setuptools.dynamic]
+readme = { file = "README.md", content-type="text/markdown" }
+
+# Main package dependencies
+dependencies = {file = "requirements/main.txt"}
+
+# Optional dependencies
+optional-dependencies.tests = {file = "requirements/tests.txt"}
+optional-dependencies.docs = {file = "requirements/docs.txt"}
+
+[project.urls]
+Homepage = "https://github.com/AndreFCruz/folktexts"    # TODO: eventually point to github pages (docs)
+Documentation = "https://andrefcruz.github.io/folktexts/"
+Repository = "https://github.com/AndreFCruz/folktexts"
+
+[tool.setuptools.packages.find]
+include = ["folktexts"]
+
+# Autopep8
+[tool.autopep8]
+max_line_length = 100
+aggressive = 1
+
+# isort
+[tool.isort]
+profile = "hug"
+force_single_line = false
+src_paths = ["folktexts", "tests"]
+
+# Pylint
+[tool.pylint.MASTER]
+[tool.pylint.FORMAT]
+max-line-length = 100
+extension-pkg-whitelist = "numpy"
+
+[tool.pylint.MESSAGES_CONTROL]
+disable = "invalid-name"
+
+# Coverage
+[tool.coverage.run]
+branch = true
+source = ["folktexts"]
+omit = ["folktexts/_version.py", "tests"]
+
+[tool.coverage.report]
+show_missing = true
+
+# MyPy
+[tool.mypy]
+ignore_missing_imports = true
+exclude = ["build", "doc"]
+
+# Tox
+[tool.tox]
+legacy_tox_ini = """
+[tox]
+envlist = py38,py39,py310
+
+[testenv]
+description = run unit tests
+commands = python -m pytest tests
+"""

folktexts-0.0/requirements/docs.txt

@@ -0,0 +1,7 @@
+sphinx
+sphinx_rtd_theme
+sphinx-autopackagesummary
+myst-parser
+sphinx-copybutton
+sphinxcontrib-bibtex
+sphinxemoji

folktexts-0.0/requirements/main.txt

@@ -0,0 +1,3 @@
+numpy
+pandas
+tqdm

folktexts-0.0/requirements/tests.txt

@@ -0,0 +1,2 @@
+pytest
+coverage

folktexts-0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

folktexts-0.0/tests/test_dummy.py

@@ -0,0 +1,8 @@
+"""Dummy test.
+"""
+
+
+def test_version_in_alpha():
+    """Checks whether we're still in alpha."""
+    from folktexts import __version__
+    assert __version__.startswith("0.")