soham-py 0.1.0__tar.gz

soham_py-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 Soham Pandit
+
+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.
+

soham_py-0.1.0/PKG-INFO

@@ -0,0 +1,233 @@
+Metadata-Version: 2.4
+Name: soham-py
+Version: 0.1.0
+Summary: College practical programs stored as plain text — retrieve them with a simple Python import.
+Author: Soham Pandit
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Soham117Pandit/soham-py
+Project-URL: Issues, https://github.com/Soham117Pandit/soham-py/issues
+Keywords: practicals,college,data-science,web-technology,dbms
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Education
+Classifier: Programming Language :: Python :: 3
+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
+Classifier: Topic :: Education
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Dynamic: license-file
+
+# SohamPy
+
+**College practical programs stored as plain text — retrieve them with a simple Python import.**
+
+SohamPy is a lightweight Python package that bundles college practical programs for three subjects as plain `.txt` files. Once installed, you can retrieve any practical from any computer using a simple import statement — no internet connection required after installation.
+
+> **Important:** SohamPy stores and returns source code as **plain text**. It never executes the stored code.
+
+---
+
+## Supported Subjects
+
+| Key    | Subject                      | Practicals |
+|--------|------------------------------|------------|
+| `ds`   | Data Science                 | 10         |
+| `wt`   | Web Technology               | 10         |
+| `dbms` | Database Management Systems  | 10         |
+
+**Total: 30 practical files.**
+
+> **Note:** SQL, MySQL, and MongoDB are topics within DBMS — they are not separate subjects.
+
+---
+
+## Installation
+
+```bash
+pip install soham-py
+```
+
+After installation, the package works **completely offline**. Internet is only needed for the initial install and future updates.
+
+---
+
+## Quick Start
+
+```python
+import soham_py
+
+# Retrieve a Data Science practical
+print(soham_py.ds(1))
+
+# Retrieve a Web Technology practical
+print(soham_py.wt(1))
+
+# Retrieve a DBMS practical
+print(soham_py.dbms(1))
+```
+
+---
+
+## Available Functions
+
+### Retrieve a Practical
+
+```python
+soham_py.ds(1)       # Data Science practical 1
+soham_py.wt(5)       # Web Technology practical 5
+soham_py.dbms(10)    # DBMS practical 10
+```
+
+Returns the complete contents of the `.txt` file as a Python string. Empty files return `""`.
+
+### List Practicals
+
+```python
+soham_py.list_practicals("ds")
+# [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+
+soham_py.list_practicals("wt")
+soham_py.list_practicals("dbms")
+```
+
+### Show Subjects
+
+```python
+soham_py.subjects()
+# [('dbms', 'Database Management Systems'),
+#  ('ds', 'Data Science'),
+#  ('wt', 'Web Technology')]
+```
+
+### Search Practicals
+
+```python
+soham_py.search("regression")
+soham_py.search("database")
+soham_py.search("HTML")
+```
+
+- Searches all three subjects.
+- Case-insensitive.
+- Skips empty files.
+- Returns a list of `{"subject", "practical", "snippet"}` dicts.
+- Returns `[]` when there are no matches.
+- Raises `ValueError` for empty or whitespace-only queries.
+
+### Save a Practical to a File
+
+```python
+soham_py.save("ds", 1, "practical1.txt")
+```
+
+- Saves the practical contents to a local file.
+- Uses UTF-8 encoding.
+- Preserves the original text exactly.
+- You can choose any output filename.
+
+---
+
+## Subject Aliases
+
+You can use alternative names for subjects:
+
+| Alias              | Resolves To |
+|--------------------|-------------|
+| `ds`               | `ds`        |
+| `data_science`     | `ds`        |
+| `wt`               | `wt`        |
+| `web`              | `wt`        |
+| `web_technology`   | `wt`        |
+| `dbms`             | `dbms`      |
+| `database`         | `dbms`      |
+
+All aliases are **case-insensitive**.
+
+---
+
+## Adding Your Practical Programs
+
+All 30 practical files are **initially empty**. To add your code:
+
+1. Find the package source in `src/soham_py/practicals/`.
+2. Open the appropriate `.txt` file (e.g., `ds/practical1.txt`).
+3. Paste your practical program as plain text.
+4. Rebuild and reinstall the package.
+
+```text
+src/soham_py/practicals/
+├── ds/
+│   ├── practical1.txt    ← Add your DS practical 1 code here
+│   ├── practical2.txt
+│   └── ...
+├── wt/
+│   ├── practical1.txt    ← Add your WT practical 1 code here
+│   └── ...
+└── dbms/
+    ├── practical1.txt    ← Add your DBMS practical 1 code here
+    └── ...
+```
+
+> **Note:** After modifying practicals in a published package, you must create a new version and upgrade via `pip install --upgrade soham-py` for the changes to take effect on other computers.
+
+---
+
+## Error Handling
+
+| Situation                | Error Raised        |
+|--------------------------|---------------------|
+| Invalid subject name     | `ValueError`        |
+| Invalid practical number | `ValueError`        |
+| Missing practical file   | `FileNotFoundError` |
+| Empty search query       | `ValueError`        |
+| Empty practical file     | Returns `""` (no error) |
+
+---
+
+## Development
+
+```bash
+# Clone the repository
+git clone https://github.com/soham-pandit/soham-py.git
+cd soham-py
+
+# Install in editable mode with dev dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest -v
+
+# Build distributions
+python -m build
+```
+
+---
+
+## Contributing
+
+1. Fork the repository.
+2. Create a feature branch.
+3. Make your changes.
+4. Run the tests.
+5. Submit a pull request.
+
+---
+
+## License
+
+This project is licensed under the **MIT License** — see the [LICENSE](LICENSE) file for details.
+
+---
+
+## Author
+
+**Soham Pandit**
+

soham_py-0.1.0/README.md

@@ -0,0 +1,206 @@
+# SohamPy
+
+**College practical programs stored as plain text — retrieve them with a simple Python import.**
+
+SohamPy is a lightweight Python package that bundles college practical programs for three subjects as plain `.txt` files. Once installed, you can retrieve any practical from any computer using a simple import statement — no internet connection required after installation.
+
+> **Important:** SohamPy stores and returns source code as **plain text**. It never executes the stored code.
+
+---
+
+## Supported Subjects
+
+| Key    | Subject                      | Practicals |
+|--------|------------------------------|------------|
+| `ds`   | Data Science                 | 10         |
+| `wt`   | Web Technology               | 10         |
+| `dbms` | Database Management Systems  | 10         |
+
+**Total: 30 practical files.**
+
+> **Note:** SQL, MySQL, and MongoDB are topics within DBMS — they are not separate subjects.
+
+---
+
+## Installation
+
+```bash
+pip install soham-py
+```
+
+After installation, the package works **completely offline**. Internet is only needed for the initial install and future updates.
+
+---
+
+## Quick Start
+
+```python
+import soham_py
+
+# Retrieve a Data Science practical
+print(soham_py.ds(1))
+
+# Retrieve a Web Technology practical
+print(soham_py.wt(1))
+
+# Retrieve a DBMS practical
+print(soham_py.dbms(1))
+```
+
+---
+
+## Available Functions
+
+### Retrieve a Practical
+
+```python
+soham_py.ds(1)       # Data Science practical 1
+soham_py.wt(5)       # Web Technology practical 5
+soham_py.dbms(10)    # DBMS practical 10
+```
+
+Returns the complete contents of the `.txt` file as a Python string. Empty files return `""`.
+
+### List Practicals
+
+```python
+soham_py.list_practicals("ds")
+# [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+
+soham_py.list_practicals("wt")
+soham_py.list_practicals("dbms")
+```
+
+### Show Subjects
+
+```python
+soham_py.subjects()
+# [('dbms', 'Database Management Systems'),
+#  ('ds', 'Data Science'),
+#  ('wt', 'Web Technology')]
+```
+
+### Search Practicals
+
+```python
+soham_py.search("regression")
+soham_py.search("database")
+soham_py.search("HTML")
+```
+
+- Searches all three subjects.
+- Case-insensitive.
+- Skips empty files.
+- Returns a list of `{"subject", "practical", "snippet"}` dicts.
+- Returns `[]` when there are no matches.
+- Raises `ValueError` for empty or whitespace-only queries.
+
+### Save a Practical to a File
+
+```python
+soham_py.save("ds", 1, "practical1.txt")
+```
+
+- Saves the practical contents to a local file.
+- Uses UTF-8 encoding.
+- Preserves the original text exactly.
+- You can choose any output filename.
+
+---
+
+## Subject Aliases
+
+You can use alternative names for subjects:
+
+| Alias              | Resolves To |
+|--------------------|-------------|
+| `ds`               | `ds`        |
+| `data_science`     | `ds`        |
+| `wt`               | `wt`        |
+| `web`              | `wt`        |
+| `web_technology`   | `wt`        |
+| `dbms`             | `dbms`      |
+| `database`         | `dbms`      |
+
+All aliases are **case-insensitive**.
+
+---
+
+## Adding Your Practical Programs
+
+All 30 practical files are **initially empty**. To add your code:
+
+1. Find the package source in `src/soham_py/practicals/`.
+2. Open the appropriate `.txt` file (e.g., `ds/practical1.txt`).
+3. Paste your practical program as plain text.
+4. Rebuild and reinstall the package.
+
+```text
+src/soham_py/practicals/
+├── ds/
+│   ├── practical1.txt    ← Add your DS practical 1 code here
+│   ├── practical2.txt
+│   └── ...
+├── wt/
+│   ├── practical1.txt    ← Add your WT practical 1 code here
+│   └── ...
+└── dbms/
+    ├── practical1.txt    ← Add your DBMS practical 1 code here
+    └── ...
+```
+
+> **Note:** After modifying practicals in a published package, you must create a new version and upgrade via `pip install --upgrade soham-py` for the changes to take effect on other computers.
+
+---
+
+## Error Handling
+
+| Situation                | Error Raised        |
+|--------------------------|---------------------|
+| Invalid subject name     | `ValueError`        |
+| Invalid practical number | `ValueError`        |
+| Missing practical file   | `FileNotFoundError` |
+| Empty search query       | `ValueError`        |
+| Empty practical file     | Returns `""` (no error) |
+
+---
+
+## Development
+
+```bash
+# Clone the repository
+git clone https://github.com/soham-pandit/soham-py.git
+cd soham-py
+
+# Install in editable mode with dev dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest -v
+
+# Build distributions
+python -m build
+```
+
+---
+
+## Contributing
+
+1. Fork the repository.
+2. Create a feature branch.
+3. Make your changes.
+4. Run the tests.
+5. Submit a pull request.
+
+---
+
+## License
+
+This project is licensed under the **MIT License** — see the [LICENSE](LICENSE) file for details.
+
+---
+
+## Author
+
+**Soham Pandit**
+

soham_py-0.1.0/pyproject.toml

@@ -0,0 +1,48 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "soham-py"
+version = "0.1.0"
+description = "College practical programs stored as plain text — retrieve them with a simple Python import."
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.9"
+authors = [
+    {name = "Soham Pandit"},
+]
+keywords = ["practicals", "college", "data-science", "web-technology", "dbms"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Education",
+    "Programming Language :: Python :: 3",
+    "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",
+    "Topic :: Education",
+    "Operating System :: OS Independent",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "build>=1.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/Soham117Pandit/soham-py"
+Issues = "https://github.com/Soham117Pandit/soham-py/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"soham_py.practicals.ds" = ["*.txt"]
+"soham_py.practicals.wt" = ["*.txt"]
+"soham_py.practicals.dbms" = ["*.txt"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

soham_py-0.1.0/setup.cfg

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

soham_py-0.1.0/src/soham_py/__init__.py

@@ -0,0 +1,102 @@
+"""SohamPy — College practical programs as importable plain text.
+
+A lightweight Python package that bundles college practical programs
+for three subjects (DS, WT, DBMS) as plain ``.txt`` files and lets
+you retrieve them with a simple import.
+
+**No stored code is ever executed.**
+
+Quick start::
+
+    import soham_py
+
+    print(soham_py.ds(1))
+    print(soham_py.wt(1))
+    print(soham_py.dbms(1))
+"""
+
+from __future__ import annotations
+
+from typing import Dict, List, Tuple
+
+from .core import get_practical, list_practicals
+from .search import search
+from .saver import save
+from .subjects import get_subjects
+
+__version__ = "0.1.0"
+__author__ = "Soham Pandit"
+__all__ = [
+    "ds",
+    "wt",
+    "dbms",
+    "list_practicals",
+    "subjects",
+    "search",
+    "save",
+    "get_practical",
+    "__version__",
+    "__author__",
+]
+
+
+# ── Convenience functions ───────────────────────────────────────────
+
+def ds(number: int) -> str:
+    """Return the contents of a Data Science practical.
+
+    Parameters
+    ----------
+    number : int
+        Practical number (1–10).
+
+    Returns
+    -------
+    str
+        Plain-text contents of the practical file.
+    """
+    return get_practical("ds", number)
+
+
+def wt(number: int) -> str:
+    """Return the contents of a Web Technology practical.
+
+    Parameters
+    ----------
+    number : int
+        Practical number (1–10).
+
+    Returns
+    -------
+    str
+        Plain-text contents of the practical file.
+    """
+    return get_practical("wt", number)
+
+
+def dbms(number: int) -> str:
+    """Return the contents of a DBMS practical.
+
+    Parameters
+    ----------
+    number : int
+        Practical number (1–10).
+
+    Returns
+    -------
+    str
+        Plain-text contents of the practical file.
+    """
+    return get_practical("dbms", number)
+
+
+def subjects() -> List[Tuple[str, str]]:
+    """Return the three primary subjects and their descriptions.
+
+    Returns
+    -------
+    list of tuple
+        ``[(key, description), ...]`` sorted alphabetically.
+    """
+    return get_subjects()
+