scholaris-sdk 2.0.0__tar.gz

scholaris_sdk-2.0.0/LICENSE

@@ -0,0 +1,190 @@
+EUROPEAN UNION PUBLIC LICENCE v. 1.2
+EUPL © the European Union 2007, 2016
+
+This European Union Public Licence (the ‘EUPL’) applies to the Work (as defined below) which is provided under the
+terms of this Licence. Any use of the Work, other than as authorised under this Licence is prohibited (to the extent such
+use is covered by a right of the copyright holder of the Work).
+The Work is provided under the terms of this Licence when the Licensor (as defined below) has placed the following
+notice immediately following the copyright notice for the Work:
+                          Licensed under the EUPL
+or has expressed by any other means his willingness to license under the EUPL.
+
+1.Definitions
+In this Licence, the following terms have the following meaning:
+— ‘The Licence’:this Licence.
+— ‘The Original Work’:the work or software distributed or communicated by the Licensor under this Licence, available
+as Source Code and also as Executable Code as the case may be.
+— ‘Derivative Works’:the works or software that could be created by the Licensee, based upon the Original Work or
+modifications thereof. This Licence does not define the extent of modification or dependence on the Original Work
+required in order to classify a work as a Derivative Work; this extent is determined by copyright law applicable in
+the country mentioned in Article 15.
+— ‘The Work’:the Original Work or its Derivative Works.
+— ‘The Source Code’:the human-readable form of the Work which is the most convenient for people to study and
+modify.
+— ‘The Executable Code’:any code which has generally been compiled and which is meant to be interpreted by
+a computer as a program.
+— ‘The Licensor’:the natural or legal person that distributes or communicates the Work under the Licence.
+— ‘Contributor(s)’:any natural or legal person who modifies the Work under the Licence, or otherwise contributes to
+the creation of a Derivative Work.
+— ‘The Licensee’ or ‘You’:any natural or legal person who makes any usage of the Work under the terms of the
+Licence.
+— ‘Distribution’ or ‘Communication’:any act of selling, giving, lending, renting, distributing, communicating,
+transmitting, or otherwise making available, online or offline, copies of the Work or providing access to its essential
+functionalities at the disposal of any other natural or legal person.
+
+2.Scope of the rights granted by the Licence
+The Licensor hereby grants You a worldwide, royalty-free, non-exclusive, sublicensable licence to do the following, for
+the duration of copyright vested in the Original Work:
+— use the Work in any circumstance and for all usage,
+— reproduce the Work,
+— modify the Work, and make Derivative Works based upon the Work,
+— communicate to the public, including the right to make available or display the Work or copies thereof to the public
+and perform publicly, as the case may be, the Work,
+— distribute the Work or copies thereof,
+— lend and rent the Work or copies thereof,
+— sublicense rights in the Work or copies thereof.
+Those rights can be exercised on any media, supports and formats, whether now known or later invented, as far as the
+applicable law permits so.
+In the countries where moral rights apply, the Licensor waives his right to exercise his moral right to the extent allowed
+by law in order to make effective the licence of the economic rights here above listed.
+The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to any patents held by the Licensor, to the
+extent necessary to make use of the rights granted on the Work under this Licence.
+
+3.Communication of the Source Code
+The Licensor may provide the Work either in its Source Code form, or as Executable Code. If the Work is provided as
+Executable Code, the Licensor provides in addition a machine-readable copy of the Source Code of the Work along with
+each copy of the Work that the Licensor distributes or indicates, in a notice following the copyright notice attached to
+the Work, a repository where the Source Code is easily and freely accessible for as long as the Licensor continues to
+distribute or communicate the Work.
+
+4.Limitations on copyright
+Nothing in this Licence is intended to deprive the Licensee of the benefits from any exception or limitation to the
+exclusive rights of the rights owners in the Work, of the exhaustion of those rights or of other applicable limitations
+thereto.
+
+5.Obligations of the Licensee
+The grant of the rights mentioned above is subject to some restrictions and obligations imposed on the Licensee. Those
+obligations are the following:
+
+Attribution right: The Licensee shall keep intact all copyright, patent or trademarks notices and all notices that refer to
+the Licence and to the disclaimer of warranties. The Licensee must include a copy of such notices and a copy of the
+Licence with every copy of the Work he/she distributes or communicates. The Licensee must cause any Derivative Work
+to carry prominent notices stating that the Work has been modified and the date of modification.
+
+Copyleft clause: If the Licensee distributes or communicates copies of the Original Works or Derivative Works, this
+Distribution or Communication will be done under the terms of this Licence or of a later version of this Licence unless
+the Original Work is expressly distributed only under this version of the Licence — for example by communicating
+‘EUPL v. 1.2 only’. The Licensee (becoming Licensor) cannot offer or impose any additional terms or conditions on the
+Work or Derivative Work that alter or restrict the terms of the Licence.
+
+Compatibility clause: If the Licensee Distributes or Communicates Derivative Works or copies thereof based upon both
+the Work and another work licensed under a Compatible Licence, this Distribution or Communication can be done
+under the terms of this Compatible Licence. For the sake of this clause, ‘Compatible Licence’ refers to the licences listed
+in the appendix attached to this Licence. Should the Licensee's obligations under the Compatible Licence conflict with
+his/her obligations under this Licence, the obligations of the Compatible Licence shall prevail.
+
+Provision of Source Code: When distributing or communicating copies of the Work, the Licensee will provide
+a machine-readable copy of the Source Code or indicate a repository where this Source will be easily and freely available
+for as long as the Licensee continues to distribute or communicate the Work.
+Legal Protection: This Licence does not grant permission to use the trade names, trademarks, service marks, or names
+of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and
+reproducing the content of the copyright notice.
+
+6.Chain of Authorship
+The original Licensor warrants that the copyright in the Original Work granted hereunder is owned by him/her or
+licensed to him/her and that he/she has the power and authority to grant the Licence.
+Each Contributor warrants that the copyright in the modifications he/she brings to the Work are owned by him/her or
+licensed to him/her and that he/she has the power and authority to grant the Licence.
+Each time You accept the Licence, the original Licensor and subsequent Contributors grant You a licence to their contributions
+to the Work, under the terms of this Licence.
+
+7.Disclaimer of Warranty
+The Work is a work in progress, which is continuously improved by numerous Contributors. It is not a finished work
+and may therefore contain defects or ‘bugs’ inherent to this type of development.
+For the above reason, the Work is provided under the Licence on an ‘as is’ basis and without warranties of any kind
+concerning the Work, including without limitation merchantability, fitness for a particular purpose, absence of defects or
+errors, accuracy, non-infringement of intellectual property rights other than copyright as stated in Article 6 of this
+Licence.
+This disclaimer of warranty is an essential part of the Licence and a condition for the grant of any rights to the Work.
+
+8.Disclaimer of Liability
+Except in the cases of wilful misconduct or damages directly caused to natural persons, the Licensor will in no event be
+liable for any direct or indirect, material or moral, damages of any kind, arising out of the Licence or of the use of the
+Work, including without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, loss
+of data or any commercial damage, even if the Licensor has been advised of the possibility of such damage. However,
+the Licensor will be liable under statutory product liability laws as far such laws apply to the Work.
+
+9.Additional agreements
+While distributing the Work, You may choose to conclude an additional agreement, defining obligations or services
+consistent with this Licence. However, if accepting obligations, You may act only on your own behalf and on your sole
+responsibility, not on behalf of the original Licensor or any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against such Contributor by
+the fact You have accepted any warranty or additional liability.
+
+10.Acceptance of the Licence
+The provisions of this Licence can be accepted by clicking on an icon ‘I agree’ placed under the bottom of a window
+displaying the text of this Licence or by affirming consent in any other similar way, in accordance with the rules of
+applicable law. Clicking on that icon indicates your clear and irrevocable acceptance of this Licence and all of its terms
+and conditions.
+Similarly, you irrevocably accept this Licence and all of its terms and conditions by exercising any rights granted to You
+by Article 2 of this Licence, such as the use of the Work, the creation by You of a Derivative Work or the Distribution
+or Communication by You of the Work or copies thereof.
+
+11.Information to the public
+In case of any Distribution or Communication of the Work by means of electronic communication by You (for example,
+by offering to download the Work from a remote location) the distribution channel or media (for example, a website)
+must at least provide to the public the information requested by the applicable law regarding the Licensor, the Licence
+and the way it may be accessible, concluded, stored and reproduced by the Licensee.
+
+12.Termination of the Licence
+The Licence and the rights granted hereunder will terminate automatically upon any breach by the Licensee of the terms
+of the Licence.
+Such a termination will not terminate the licences of any person who has received the Work from the Licensee under
+the Licence, provided such persons remain in full compliance with the Licence.
+
+13.Miscellaneous
+Without prejudice of Article 9 above, the Licence represents the complete agreement between the Parties as to the
+Work.
+If any provision of the Licence is invalid or unenforceable under applicable law, this will not affect the validity or
+enforceability of the Licence as a whole. Such provision will be construed or reformed so as necessary to make it valid
+and enforceable.
+The European Commission may publish other linguistic versions or new versions of this Licence or updated versions of
+the Appendix, so far this is required and reasonable, without reducing the scope of the rights granted by the Licence.
+New versions of the Licence will be published with a unique version number.
+All linguistic versions of this Licence, approved by the European Commission, have identical value. Parties can take
+advantage of the linguistic version of their choice.
+
+14.Jurisdiction
+Without prejudice to specific agreement between parties,
+— any litigation resulting from the interpretation of this License, arising between the European Union institutions,
+bodies, offices or agencies, as a Licensor, and any Licensee, will be subject to the jurisdiction of the Court of Justice
+of the European Union, as laid down in article 272 of the Treaty on the Functioning of the European Union,
+— any litigation arising between other parties and resulting from the interpretation of this License, will be subject to
+the exclusive jurisdiction of the competent court where the Licensor resides or conducts its primary business.
+
+15.Applicable Law
+Without prejudice to specific agreement between parties,
+— this Licence shall be governed by the law of the European Union Member State where the Licensor has his seat,
+resides or has his registered office,
+— this licence shall be governed by Belgian law if the Licensor has no seat, residence or registered office inside
+a European Union Member State.
+
+
+                                                         Appendix
+
+‘Compatible Licences’ according to Article 5 EUPL are:
+— GNU General Public License (GPL) v. 2, v. 3
+— GNU Affero General Public License (AGPL) v. 3
+— Open Software License (OSL) v. 2.1, v. 3.0
+— Eclipse Public License (EPL) v. 1.0
+— CeCILL v. 2.0, v. 2.1
+— Mozilla Public Licence (MPL) v. 2
+— GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
+— Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for works other than software
+— European Union Public Licence (EUPL) v. 1.1, v. 1.2
+— Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong Reciprocity (LiLiQ-R+).
+
+The European Commission may update this Appendix to later versions of the above licences without producing
+a new version of the EUPL, as long as they provide the rights granted in Article 2 of this Licence and protect the
+covered Source Code from exclusive appropriation.
+All other changes or additions to this Appendix require the production of a new EUPL version.

scholaris_sdk-2.0.0/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.4
+Name: scholaris-sdk
+Version: 2.0.0
+Summary: Cliente de Python para Scholaris: API de citas con página verificada y lector de SPDF 4.0 sin conexión
+Author-email: José Luis Saorín Ferrer <jl@joseluissaorin.com>
+License-Expression: EUPL-1.2
+Project-URL: Homepage, https://scholaris.joseluissaorin.com
+Project-URL: Documentation, https://scholaris.joseluissaorin.com/api
+Project-URL: Source, https://github.com/joseluissaorin/scholaris-v2
+Project-URL: Issues, https://github.com/joseluissaorin/scholaris-v2/issues
+Keywords: scholaris,citas,citations,spdf,bibliografía,rag,academic
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: Spanish
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Text Processing :: Markup
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.31.0
+Provides-Extra: vectores
+Requires-Dist: numpy>=1.24.0; extra == "vectores"
+Provides-Extra: v1
+Requires-Dist: python-dotenv>=1.0.0; extra == "v1"
+Requires-Dist: pdf2bib>=1.2; extra == "v1"
+Requires-Dist: bibtexparser>=1.4.0; extra == "v1"
+Requires-Dist: PyPaperBot>=1.2.0; extra == "v1"
+Requires-Dist: google-generativeai>=0.3.0; extra == "v1"
+Requires-Dist: google-api-python-client>=2.0.0; extra == "v1"
+Requires-Dist: python-docx>=0.8.11; extra == "v1"
+Requires-Dist: markdown>=3.4.0; extra == "v1"
+Requires-Dist: beautifulsoup4>=4.11.0; extra == "v1"
+Requires-Dist: PyMuPDF>=1.23.0; extra == "v1"
+Requires-Dist: numpy>=1.24.0; extra == "v1"
+Requires-Dist: Pillow>=9.0.0; extra == "v1"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: numpy>=1.24.0; extra == "dev"
+Dynamic: license-file
+
+# scholaris-sdk
+
+Cliente de Python para [Scholaris](https://scholaris.joseluissaorin.com), la
+biblioteca académica que lee tus fuentes (PDF, EPUB, webs, vídeos, pódcast) y
+cita con el número de página impreso, verificado contra el texto. Incluye
+además un lector de SPDF 4.0 que funciona sin conexión.
+
+*Python client for Scholaris: upload sources, search them, ask questions and
+get citations with verified printed page numbers; plus an offline reader for
+SPDF 4.0 files. The API speaks Spanish identifiers; errors carry both a Spanish
+`mensaje` and an English `message`.*
+
+```bash
+pip install scholaris-sdk                 # solo depende de requests
+pip install "scholaris-sdk[vectores]"     # numpy, para la búsqueda vectorial sin conexión
+```
+
+El paquete se importa como `scholaris`. Requiere Python 3.9 o posterior.
+
+## Primeros pasos con la instancia pública
+
+Crea una clave en Scholaris (Ajustes → Claves de API) y guárdala en la
+variable `SCHOLARIS_CLAVE` o pásala directamente:
+
+```python
+from scholaris.api import Scholaris
+
+s = Scholaris("sch_…")                        # o la variable SCHOLARIS_CLAVE
+doc = s.subir("articulo.pdf")                  # también una URL: web, PDF, YouTube, pódcast
+for p in s.buscar("atención escalada", k=3):
+    print(p["cita"], p["texto"][:80])          # «(Vaswani et al., 2017, p. 4)»
+print(s.preguntar("¿Qué es la atención multicabeza?")["respuesta"])   # Markdown con notas [^n]
+print(s.citar("La atención sustituye a la recurrencia.")["texto"])
+print(s.verificar("El Transformer prescinde de la recurrencia.")["veredicto"])
+print(s.texto(doc["id"], desde="23", hasta="25", markdown=True))       # páginas por su folio impreso
+```
+
+`scholaris.api` es la API pública v1 (`/api/v1`), pensada para lo más común.
+La guía completa está en <https://scholaris.joseluissaorin.com/api>. Los errores
+son `ErrorScholaris`, con `codigo`, `mensaje` (español) y `message` (inglés).
+
+## Contra un servidor local
+
+Scholaris también funciona en tu ordenador con SQLite y el disco. Desde el
+repositorio:
+
+```bash
+pnpm install
+pnpm --filter @scholaris/local start      # escucha en http://localhost:8790
+```
+
+```python
+from scholaris.api import Scholaris
+
+s = Scholaris(base="http://localhost:8790")   # sin clave si no defines SCHOLARIS_TOKEN
+```
+
+Si arrancas el servidor con `SCHOLARIS_TOKEN=…`, pasa ese mismo valor como
+clave. La URL por defecto también se puede fijar con la variable `SCHOLARIS_URL`.
+
+## La API completa (v2)
+
+Bibliotecas compartidas, metadatos, autocitas de documentos enteros, paquetes
+`.scholaris` y descarga de SPDF:
+
+```python
+from scholaris.v2 import Scholaris
+
+s = Scholaris("https://scholaris.joseluissaorin.com", clave="sch_…")
+doc = s.subir("articulo.pdf")                     # sube, convierte y espera a que esté listo
+s.subir_url("https://www.youtube.com/watch?v=…")
+for r in s.buscar("atención escalada", k=5):
+    print(r["citaCorta"], r["fragmento"]["texto"][:80])
+print(s.respuesta("¿Qué es la atención multicabeza?")["texto"])
+s.descargar_spdf(doc["id"], "articulo.spdf")
+autocita = s.autocitar("mi-trabajo.docx", estilo="apa")
+s.exportar_autocita(autocita["id"], "mi-trabajo-citado.docx")
+```
+
+Los errores son `ErrorApi`, con `estado`, `codigo` y `mensaje`.
+
+## SPDF 4.0 sin conexión
+
+Un SPDF es el documento ya procesado (texto por páginas con su folio impreso,
+fragmentos, metadatos y, si se quiere, el original) en un único fichero
+SQLite. Se lee sin red ni clave:
+
+```python
+from scholaris.v2 import SPDF
+
+with SPDF.abrir("vigilar.spdf") as s:
+    print(s.documento["metadatos"]["titulo"])
+    for f in s.buscar("panóptico", k=5):       # FTS5, insensible a acentos
+        print(f.cita, f.texto[:80])            # «(Foucault, 1975, p. 23) …»
+    print(s.pagina("145").texto)               # por número de página impreso
+```
+
+## La v1 local
+
+La primera versión de Scholaris (procesado local con PyMuPDF y Gemini,
+`CitationIndex`, SPDF 1.0 a 3.0 y la orden `scholaris`) sigue dentro del
+paquete como extra opcional:
+
+```bash
+pip install "scholaris-sdk[v1]"
+```
+
+Su documentación está en <https://github.com/joseluissaorin/scholaris>.
+
+## Nota sobre el nombre
+
+En PyPI ya existe un proyecto distinto llamado `scholaris`, que también se
+importa como `scholaris`. No instales los dos en el mismo entorno.
+
+## Licencia
+
+[EUPL-1.2](https://interoperable-europe.ec.europa.eu/collection/eupl/eupl-text-eupl-12).
+Código fuente: <https://github.com/joseluissaorin/scholaris-v2>.

scholaris_sdk-2.0.0/README.md

@@ -0,0 +1,118 @@
+# scholaris-sdk
+
+Cliente de Python para [Scholaris](https://scholaris.joseluissaorin.com), la
+biblioteca académica que lee tus fuentes (PDF, EPUB, webs, vídeos, pódcast) y
+cita con el número de página impreso, verificado contra el texto. Incluye
+además un lector de SPDF 4.0 que funciona sin conexión.
+
+*Python client for Scholaris: upload sources, search them, ask questions and
+get citations with verified printed page numbers; plus an offline reader for
+SPDF 4.0 files. The API speaks Spanish identifiers; errors carry both a Spanish
+`mensaje` and an English `message`.*
+
+```bash
+pip install scholaris-sdk                 # solo depende de requests
+pip install "scholaris-sdk[vectores]"     # numpy, para la búsqueda vectorial sin conexión
+```
+
+El paquete se importa como `scholaris`. Requiere Python 3.9 o posterior.
+
+## Primeros pasos con la instancia pública
+
+Crea una clave en Scholaris (Ajustes → Claves de API) y guárdala en la
+variable `SCHOLARIS_CLAVE` o pásala directamente:
+
+```python
+from scholaris.api import Scholaris
+
+s = Scholaris("sch_…")                        # o la variable SCHOLARIS_CLAVE
+doc = s.subir("articulo.pdf")                  # también una URL: web, PDF, YouTube, pódcast
+for p in s.buscar("atención escalada", k=3):
+    print(p["cita"], p["texto"][:80])          # «(Vaswani et al., 2017, p. 4)»
+print(s.preguntar("¿Qué es la atención multicabeza?")["respuesta"])   # Markdown con notas [^n]
+print(s.citar("La atención sustituye a la recurrencia.")["texto"])
+print(s.verificar("El Transformer prescinde de la recurrencia.")["veredicto"])
+print(s.texto(doc["id"], desde="23", hasta="25", markdown=True))       # páginas por su folio impreso
+```
+
+`scholaris.api` es la API pública v1 (`/api/v1`), pensada para lo más común.
+La guía completa está en <https://scholaris.joseluissaorin.com/api>. Los errores
+son `ErrorScholaris`, con `codigo`, `mensaje` (español) y `message` (inglés).
+
+## Contra un servidor local
+
+Scholaris también funciona en tu ordenador con SQLite y el disco. Desde el
+repositorio:
+
+```bash
+pnpm install
+pnpm --filter @scholaris/local start      # escucha en http://localhost:8790
+```
+
+```python
+from scholaris.api import Scholaris
+
+s = Scholaris(base="http://localhost:8790")   # sin clave si no defines SCHOLARIS_TOKEN
+```
+
+Si arrancas el servidor con `SCHOLARIS_TOKEN=…`, pasa ese mismo valor como
+clave. La URL por defecto también se puede fijar con la variable `SCHOLARIS_URL`.
+
+## La API completa (v2)
+
+Bibliotecas compartidas, metadatos, autocitas de documentos enteros, paquetes
+`.scholaris` y descarga de SPDF:
+
+```python
+from scholaris.v2 import Scholaris
+
+s = Scholaris("https://scholaris.joseluissaorin.com", clave="sch_…")
+doc = s.subir("articulo.pdf")                     # sube, convierte y espera a que esté listo
+s.subir_url("https://www.youtube.com/watch?v=…")
+for r in s.buscar("atención escalada", k=5):
+    print(r["citaCorta"], r["fragmento"]["texto"][:80])
+print(s.respuesta("¿Qué es la atención multicabeza?")["texto"])
+s.descargar_spdf(doc["id"], "articulo.spdf")
+autocita = s.autocitar("mi-trabajo.docx", estilo="apa")
+s.exportar_autocita(autocita["id"], "mi-trabajo-citado.docx")
+```
+
+Los errores son `ErrorApi`, con `estado`, `codigo` y `mensaje`.
+
+## SPDF 4.0 sin conexión
+
+Un SPDF es el documento ya procesado (texto por páginas con su folio impreso,
+fragmentos, metadatos y, si se quiere, el original) en un único fichero
+SQLite. Se lee sin red ni clave:
+
+```python
+from scholaris.v2 import SPDF
+
+with SPDF.abrir("vigilar.spdf") as s:
+    print(s.documento["metadatos"]["titulo"])
+    for f in s.buscar("panóptico", k=5):       # FTS5, insensible a acentos
+        print(f.cita, f.texto[:80])            # «(Foucault, 1975, p. 23) …»
+    print(s.pagina("145").texto)               # por número de página impreso
+```
+
+## La v1 local
+
+La primera versión de Scholaris (procesado local con PyMuPDF y Gemini,
+`CitationIndex`, SPDF 1.0 a 3.0 y la orden `scholaris`) sigue dentro del
+paquete como extra opcional:
+
+```bash
+pip install "scholaris-sdk[v1]"
+```
+
+Su documentación está en <https://github.com/joseluissaorin/scholaris>.
+
+## Nota sobre el nombre
+
+En PyPI ya existe un proyecto distinto llamado `scholaris`, que también se
+importa como `scholaris`. No instales los dos en el mismo entorno.
+
+## Licencia
+
+[EUPL-1.2](https://interoperable-europe.ec.europa.eu/collection/eupl/eupl-text-eupl-12).
+Código fuente: <https://github.com/joseluissaorin/scholaris-v2>.

scholaris_sdk-2.0.0/pyproject.toml

@@ -0,0 +1,81 @@
+[build-system]
+requires = ["setuptools>=77.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "scholaris-sdk"
+version = "2.0.0"
+authors = [
+    {name = "José Luis Saorín Ferrer", email = "jl@joseluissaorin.com"},
+]
+description = "Cliente de Python para Scholaris: API de citas con página verificada y lector de SPDF 4.0 sin conexión"
+readme = "README.md"
+license = "EUPL-1.2"
+license-files = ["LICENSE"]
+requires-python = ">=3.9"
+keywords = ["scholaris", "citas", "citations", "spdf", "bibliografía", "rag", "academic"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Developers",
+    "Natural Language :: Spanish",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Topic :: Scientific/Engineering :: Information Analysis",
+    "Topic :: Text Processing :: Markup",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+    "requests>=2.31.0",
+]
+
+[project.optional-dependencies]
+vectores = ["numpy>=1.24.0"]
+v1 = [
+    "python-dotenv>=1.0.0",
+    "pdf2bib>=1.2",
+    "bibtexparser>=1.4.0",
+    "PyPaperBot>=1.2.0",
+    "google-generativeai>=0.3.0",
+    "google-api-python-client>=2.0.0",
+    "python-docx>=0.8.11",
+    "markdown>=3.4.0",
+    "beautifulsoup4>=4.11.0",
+    "PyMuPDF>=1.23.0",
+    "numpy>=1.24.0",
+    "Pillow>=9.0.0",
+]
+dev = [
+    "pytest>=7.0.0",
+    "numpy>=1.24.0",
+]
+
+[project.scripts]
+scholaris = "scholaris.cli:main"
+
+[project.urls]
+Homepage = "https://scholaris.joseluissaorin.com"
+Documentation = "https://scholaris.joseluissaorin.com/api"
+Source = "https://github.com/joseluissaorin/scholaris-v2"
+Issues = "https://github.com/joseluissaorin/scholaris-v2/issues"
+
+# Solo se publica el paquete `scholaris`. `spdf/` (referencia de los formatos
+# SPDF 1.0 a 3.0) se queda en el repositorio: su nombre ya existe en PyPI.
+[tool.setuptools.packages.find]
+include = ["scholaris", "scholaris.*"]
+
+[tool.black]
+line-length = 100
+target-version = ['py39', 'py310', 'py311', 'py312']
+
+[tool.mypy]
+python_version = "3.9"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = false

scholaris_sdk-2.0.0/scholaris/__init__.py

@@ -0,0 +1,48 @@
+"""Scholaris - Academic Research Automation Library.
+
+A Python library for academic research automation including:
+- Bibliography search and download
+- BibTeX generation
+- Literature review generation
+- Academic writing assistance
+"""
+
+import importlib
+from typing import Any
+
+# La v1 (procesado local con PyMuPDF y Gemini) se carga solo si se usa: así
+# `scholaris.v2` (lector de SPDF 4.0 y cliente de la API) no necesita sus dependencias.
+_PEREZOSOS = {
+    "Config": ".config",
+    "ScholarisError": ".exceptions", "ConfigurationError": ".exceptions", "SearchError": ".exceptions",
+    "DownloadError": ".exceptions", "BibTeXError": ".exceptions", "LLMError": ".exceptions",
+    "RateLimitError": ".exceptions", "ConversionError": ".exceptions", "ValidationError": ".exceptions",
+    "Paper": ".core.models", "Reference": ".core.models", "Section": ".core.models", "Review": ".core.models",
+    "Scholaris": ".scholaris",
+}
+
+
+def __getattr__(nombre: str) -> Any:
+    if nombre in _PEREZOSOS:
+        return getattr(importlib.import_module(_PEREZOSOS[nombre], __name__), nombre)
+    raise AttributeError(nombre)
+
+
+__version__ = "2.0.0"
+__all__ = [
+    "Scholaris",
+    "Config",
+    "Paper",
+    "Reference",
+    "Section",
+    "Review",
+    "ScholarisError",
+    "ConfigurationError",
+    "SearchError",
+    "DownloadError",
+    "BibTeXError",
+    "LLMError",
+    "RateLimitError",
+    "ConversionError",
+    "ValidationError",
+]