biscuitcutter 1.0.0__tar.gz

biscuitcutter-1.0.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2022 Erdogan Taskesen
+biscuitcutter - Python package
+
+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.

biscuitcutter-1.0.0/MANIFEST.in

@@ -0,0 +1 @@
+include biscuitcutter/template.zip

biscuitcutter-1.0.0/PKG-INFO

@@ -0,0 +1,130 @@
+Metadata-Version: 2.4
+Name: biscuitcutter
+Version: 1.0.0
+Summary: biscuitcutter – scaffold a new Python repo from a template in seconds.
+Author-email: Erdogan Taskesen <erdogant@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://erdogant.github.io/biscuitcutter
+Project-URL: Download, https://github.com/erdogant/biscuitcutter/archive/{version}.tar.gz
+Keywords: Python,biscuitcutter,templates,scaffolding,cookiecutter
+Classifier: Programming Language :: Python :: 3
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: Unix
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+[![Python](https://img.shields.io/pypi/pyversions/biscuitcutter)](https://img.shields.io/pypi/pyversions/biscuitcutter)
+[![Pypi](https://img.shields.io/pypi/v/biscuitcutter)](https://pypi.org/project/biscuitcutter/)
+[![Docs](https://img.shields.io/badge/Sphinx-Docs-Green)](https://erdogant.github.io/biscuitcutter/)
+[![LOC](https://sloc.xyz/github/erdogant/biscuitcutter/?category=code)](https://github.com/erdogant/biscuitcutter/)
+[![Downloads](https://static.pepy.tech/personalized-badge/biscuitcutter?period=month&units=international_system&left_color=grey&right_color=brightgreen&left_text=PyPI%20downloads/month)](https://pepy.tech/project/biscuitcutter)
+[![Downloads](https://static.pepy.tech/personalized-badge/biscuitcutter?period=total&units=international_system&left_color=grey&right_color=brightgreen&left_text=Downloads)](https://pepy.tech/project/biscuitcutter)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/erdogant/biscuitcutter/blob/master/LICENSE)
+[![Forks](https://img.shields.io/github/forks/erdogant/biscuitcutter.svg)](https://github.com/erdogant/biscuitcutter/network)
+[![Issues](https://img.shields.io/github/issues/erdogant/biscuitcutter.svg)](https://github.com/erdogant/biscuitcutter/issues)
+[![Project Status](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)
+
+<div>
+<a href="https://erdogant.github.io/biscuitcutter/">
+  <img src="https://raw.githubusercontent.com/erdogant/biscuitcutter/master/docs/figs/logo.png"
+       width="250"
+       align="left" />
+</a>
+<strong>biscuitcutter</strong> is a new repository scaffolder for Python projects.
+
+Create a new Python package or repository with a single command! ⭐️Star it if you like it⭐️
+</div>
+
+---
+
+### Key Features
+
+| Feature | Description |
+|--------|-------------|
+| [**Interactive CLI**](https://erdogant.github.io/biscuitcutter/pages/html/Installation.html) | Scaffold a new Python repository with prompts for repo name, author info, and more. |
+| [**Template-Based**](https://erdogant.github.io/biscuitcutter/) | Uses a pre-configured template to create a ready-to-use project structure. |
+| [**Placeholder Replacement**](https://erdogant.github.io/biscuitcutter/) | Automatically replaces placeholders (repo name, author, email, GitHub username) in all files. |
+
+---
+
+### Resources and Links
+- **Documentation:** [Website](https://erdogant.github.io/biscuitcutter)
+- **Bug Reports and Feature Requests:** [GitHub Issues](https://github.com/erdogant/biscuitcutter/issues)
+
+---
+
+### Installation
+
+##### Install biscuitcutter from PyPI
+```bash
+pip install biscuitcutter
+```
+---
+
+### Usage
+
+After installation, run the interactive CLI:
+
+```bash
+biscuitcutter
+```
+
+This will prompt you for:
+
+- **Repository / package name** (required)
+- **Author full name** (required)
+- **Author e-mail** (optional)
+- **GitHub username** (optional, defaults to lowercase author name without spaces)
+- **Parent directory** (optional, defaults to current directory)
+
+Alternatively, you can import and call the main function directly:
+
+```python
+from biscuitcutter import main
+main()
+```
+
+---
+
+### Example Session
+
+```console
+🍪  biscuitcutter – new repo scaffolder
+
+───────────────────────────────────────────
+  Repository / package name: my_project
+  Author full name: Erdogan Taskesen
+  Author e-mail: erdogant@gmail.com
+  GitHub username: erdogant
+  Parent directory (leave blank for current dir):
+
+✔  Created directory: /path/to/my_project
+✔  Template extracted to: /path/to/my_project
+✔  Placeholders replaced.
+
+🎉  Done!  Your new repo is ready at:
+    /path/to/my_project
+```
+
+---
+
+### Contributors
+
+Setting up and maintaining biscuitcutter has been possible thanks to users and contributors. Thanks to:
+
+<p align="left">
+  <a href="https://github.com/erdogant/biscuitcutter/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=erdogant/biscuitcutter" />
+  </a>
+</p>
+
+### Maintainer
+* Erdogan Taskesen, github: [erdogant](https://github.com/erdogant)
+* Contributions are welcome.

biscuitcutter-1.0.0/README.md

@@ -0,0 +1,108 @@
+[![Python](https://img.shields.io/pypi/pyversions/biscuitcutter)](https://img.shields.io/pypi/pyversions/biscuitcutter)
+[![Pypi](https://img.shields.io/pypi/v/biscuitcutter)](https://pypi.org/project/biscuitcutter/)
+[![Docs](https://img.shields.io/badge/Sphinx-Docs-Green)](https://erdogant.github.io/biscuitcutter/)
+[![LOC](https://sloc.xyz/github/erdogant/biscuitcutter/?category=code)](https://github.com/erdogant/biscuitcutter/)
+[![Downloads](https://static.pepy.tech/personalized-badge/biscuitcutter?period=month&units=international_system&left_color=grey&right_color=brightgreen&left_text=PyPI%20downloads/month)](https://pepy.tech/project/biscuitcutter)
+[![Downloads](https://static.pepy.tech/personalized-badge/biscuitcutter?period=total&units=international_system&left_color=grey&right_color=brightgreen&left_text=Downloads)](https://pepy.tech/project/biscuitcutter)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/erdogant/biscuitcutter/blob/master/LICENSE)
+[![Forks](https://img.shields.io/github/forks/erdogant/biscuitcutter.svg)](https://github.com/erdogant/biscuitcutter/network)
+[![Issues](https://img.shields.io/github/issues/erdogant/biscuitcutter.svg)](https://github.com/erdogant/biscuitcutter/issues)
+[![Project Status](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)
+
+<div>
+<a href="https://erdogant.github.io/biscuitcutter/">
+  <img src="https://raw.githubusercontent.com/erdogant/biscuitcutter/master/docs/figs/logo.png"
+       width="250"
+       align="left" />
+</a>
+<strong>biscuitcutter</strong> is a new repository scaffolder for Python projects.
+
+Create a new Python package or repository with a single command! ⭐️Star it if you like it⭐️
+</div>
+
+---
+
+### Key Features
+
+| Feature | Description |
+|--------|-------------|
+| [**Interactive CLI**](https://erdogant.github.io/biscuitcutter/pages/html/Installation.html) | Scaffold a new Python repository with prompts for repo name, author info, and more. |
+| [**Template-Based**](https://erdogant.github.io/biscuitcutter/) | Uses a pre-configured template to create a ready-to-use project structure. |
+| [**Placeholder Replacement**](https://erdogant.github.io/biscuitcutter/) | Automatically replaces placeholders (repo name, author, email, GitHub username) in all files. |
+
+---
+
+### Resources and Links
+- **Documentation:** [Website](https://erdogant.github.io/biscuitcutter)
+- **Bug Reports and Feature Requests:** [GitHub Issues](https://github.com/erdogant/biscuitcutter/issues)
+
+---
+
+### Installation
+
+##### Install biscuitcutter from PyPI
+```bash
+pip install biscuitcutter
+```
+---
+
+### Usage
+
+After installation, run the interactive CLI:
+
+```bash
+biscuitcutter
+```
+
+This will prompt you for:
+
+- **Repository / package name** (required)
+- **Author full name** (required)
+- **Author e-mail** (optional)
+- **GitHub username** (optional, defaults to lowercase author name without spaces)
+- **Parent directory** (optional, defaults to current directory)
+
+Alternatively, you can import and call the main function directly:
+
+```python
+from biscuitcutter import main
+main()
+```
+
+---
+
+### Example Session
+
+```console
+🍪  biscuitcutter – new repo scaffolder
+
+───────────────────────────────────────────
+  Repository / package name: my_project
+  Author full name: Erdogan Taskesen
+  Author e-mail: erdogant@gmail.com
+  GitHub username: erdogant
+  Parent directory (leave blank for current dir):
+
+✔  Created directory: /path/to/my_project
+✔  Template extracted to: /path/to/my_project
+✔  Placeholders replaced.
+
+🎉  Done!  Your new repo is ready at:
+    /path/to/my_project
+```
+
+---
+
+### Contributors
+
+Setting up and maintaining biscuitcutter has been possible thanks to users and contributors. Thanks to:
+
+<p align="left">
+  <a href="https://github.com/erdogant/biscuitcutter/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=erdogant/biscuitcutter" />
+  </a>
+</p>
+
+### Maintainer
+* Erdogan Taskesen, github: [erdogant](https://github.com/erdogant)
+* Contributions are welcome.

biscuitcutter-1.0.0/biscuitcutter/__init__.py

@@ -0,0 +1,42 @@
+import logging
+
+# We import 'main' instead of 'biscuitcutter' since that is the actual entry point in your script.
+from biscuitcutter.biscuitcutter import main
+
+__author__ = 'Erdogan Taskesen'
+__email__ = 'erdogant@gmail.com'
+__version__ = '1.0.0'
+
+# Setup package-level logger
+_logger = logging.getLogger('biscuitcutter')
+_log_handler = logging.StreamHandler()
+_formatter = logging.Formatter(fmt='[{asctime}] [{name:<12.12}] [{levelname:<8}] {message}', style='{', datefmt='%d-%m-%Y %H:%M:%S')
+_log_handler.setFormatter(_formatter)
+_log_handler.setLevel(logging.DEBUG)
+if not _logger.hasHandlers():  # avoid duplicate handlers if re-imported
+    _logger.addHandler(_log_handler)
+_logger.setLevel(logging.DEBUG)
+_logger.propagate = True  # allow submodules to inherit this handler
+
+
+# module level doc-string
+__doc__ = """
+biscuitcutter
+=====================================================================
+
+biscuitcutter is a new repo scaffolder using command line interface.
+
+Example
+-------
+>>> # Install
+>>> pip install biscuitcutter
+>>> # From the terminal run:
+>>> biscuitcutter
+>>>
+
+
+References
+----------
+https://github.com/erdogant/biscuitcutter
+
+"""

biscuitcutter-1.0.0/biscuitcutter/biscuitcutter.py

@@ -0,0 +1,194 @@
+"""biscuitcutter.
+
+Name        : biscuitcutter.py
+Author      : Erdogan Taskesen
+Contact     : erdogant@gmail.com
+github      : https://github.com/erdogant/biscuitcutter
+Licence     : MIT
+
+"""
+
+import os
+import sys
+import zipfile
+import shutil
+import logging
+
+logger = logging.getLogger(__name__)
+
+TEMPLATE_PLACEHOLDER_GITHUB = "GITHUBNAME"
+TEMPLATE_PLACEHOLDER_REPO   = "REPONAME"
+TEMPLATE_PLACEHOLDER_AUTHOR = "AUTHORNAME"
+TEMPLATE_PLACEHOLDER_EMAIL  = "CONTACTADRESS"
+
+
+# ---------------------------------------------------------------------------
+# CLI entry-point
+# ---------------------------------------------------------------------------
+
+def main():
+    """Interactive CLI: scaffold a new Python repo from the biscuitcutter template.
+
+    Example
+    -------
+    >>> # Install
+    >>> pip install biscuitcutter
+    >>> # From the terminal run:
+    >>> biscuitcutter
+
+    """
+    print("\n🍪  biscuitcutter – new repo scaffolder\n" + "─" * 42)
+
+    # ── 1. Collect user input ───────────────────────────────────────────────
+    repo_name   = _prompt("Repository / package name", required=True)
+    author_name = _prompt("Author full name",          required=True)
+    author_email= _prompt("Author e-mail",             required=False, default="")
+    github_user = _prompt("GitHub username",           required=False, default=author_name.lower().replace(" ", ""))
+
+    output_dir  = _prompt(
+        "Parent directory (leave blank for current dir)",
+        required=False,
+        default=os.getcwd(),
+    )
+
+    repo_dir = os.path.join(output_dir, repo_name)
+
+    # ── 2. Create repo directory ────────────────────────────────────────────
+    if os.path.exists(repo_dir):
+        overwrite = input(f"\n⚠️  '{repo_dir}' already exists. Overwrite? [y/N]: ").strip().lower()
+        if overwrite != "y":
+            print("Aborted.")
+            sys.exit(0)
+        shutil.rmtree(repo_dir)
+
+    os.makedirs(repo_dir)
+    print(f"\n✔  Created directory: {repo_dir}")
+
+    # ── 3. Download & extract template.zip ─────────────────────────────────
+    target_directory = os.path.dirname(os.path.abspath(__file__))
+    zip_path = os.path.join(target_directory, 'template.zip')
+    print(f"directory: {target_directory}")
+    print(f"Template: {zip_path}")
+
+    _extract_zip(zip_path, repo_dir)
+    # os.remove(zip_path)
+    print(f"✔  Template extracted to: {repo_dir}")
+
+    # ── 4. Rename variables / placeholders inside all text files ───────────
+    replacements = {
+        TEMPLATE_PLACEHOLDER_REPO:   repo_name,
+        TEMPLATE_PLACEHOLDER_AUTHOR: author_name,
+        TEMPLATE_PLACEHOLDER_EMAIL:  author_email,
+        TEMPLATE_PLACEHOLDER_GITHUB: github_user,
+    }
+    _rename_in_tree(repo_dir, replacements)
+    _rename_paths(repo_dir, TEMPLATE_PLACEHOLDER_REPO, repo_name)
+
+    print(f"✔  Placeholders replaced.")
+    print(f"\n🎉  Done!  Your new repo is ready at:\n    {repo_dir}\n")
+
+
+# ---------------------------------------------------------------------------
+# Helpers
+# ---------------------------------------------------------------------------
+
+def _prompt(label, required=True, default=None):
+    suffix = f" [{default}]" if default else ""
+    while True:
+        value = input(f"  {label}{suffix}: ").strip()
+        if not value and default is not None:
+            return default
+        if not value and required:
+            print(f"    ✗  '{label}' is required.")
+            continue
+        return value or ""
+
+
+def _create_stub_zip(dest_path, placeholder):
+    """Create a minimal stub zip when the real template is unavailable."""
+    import io, zipfile as zf
+
+    buf = io.BytesIO()
+    with zf.ZipFile(buf, "w") as z:
+        z.writestr(f"{placeholder}/__init__.py",   f"# {placeholder}\n__version__ = '0.1.0'\n")
+        z.writestr(f"{placeholder}/{placeholder}.py",
+                   f'"""{placeholder}."""\n\nclass {placeholder}:\n    pass\n')
+        z.writestr("README.md",    f"# {placeholder}\n\nA new Python library.\n")
+        z.writestr("pyproject.toml",
+                   f'[project]\nname = "{placeholder}"\n'
+                   f'authors = [{{name = "Erdogan Taskesen", email = "erdogant@gmail.com"}}]\n')
+    with open(dest_path, "wb") as fh:
+        fh.write(buf.getvalue())
+
+
+def _extract_zip(zip_path, dest_dir):
+    """Extract zip; if the archive has a single top-level folder, strip it."""
+    with zipfile.ZipFile(zip_path, "r") as z:
+        members = z.namelist()
+        # Detect common prefix (GitHub zips add a top-level folder)
+        top_dirs = {m.split("/")[0] for m in members if "/" in m}
+        strip = ""
+        if len(top_dirs) == 1:
+            candidate = top_dirs.pop() + "/"
+            if all(m.startswith(candidate) or m == candidate.rstrip("/") for m in members):
+                strip = candidate
+
+        for member in members:
+            rel = member[len(strip):] if strip and member.startswith(strip) else member
+            if not rel:
+                continue
+            target = os.path.join(dest_dir, rel)
+            if member.endswith("/"):
+                os.makedirs(target, exist_ok=True)
+            else:
+                os.makedirs(os.path.dirname(target), exist_ok=True)
+                with z.open(member) as src, open(target, "wb") as dst:
+                    shutil.copyfileobj(src, dst)
+
+
+def _rename_in_tree(root, replacements):
+    """Walk *root* and replace placeholder strings in every text file."""
+    TEXT_EXTENSIONS = {
+        ".py", ".md", ".rst", ".txt", ".toml", ".cfg", ".ini",
+        ".yml", ".yaml", ".json", ".html", ".js", ".css", ".sh",
+        ".bat", ".ps1", "",
+    }
+    for dirpath, _dirs, files in os.walk(root):
+        for fname in files:
+            _, ext = os.path.splitext(fname)
+            if ext.lower() not in TEXT_EXTENSIONS:
+                continue
+            fpath = os.path.join(dirpath, fname)
+            try:
+                with open(fpath, "r", encoding="utf-8", errors="replace") as fh:
+                    content = fh.read()
+                new_content = content
+                for old, new in replacements.items():
+                    new_content = new_content.replace(old, new)
+                if new_content != content:
+                    with open(fpath, "w", encoding="utf-8") as fh:
+                        fh.write(new_content)
+            except Exception as exc:
+                logger.debug(f"Skipping {fpath}: {exc}")
+
+
+def _rename_paths(root, old_name, new_name):
+    """Rename files and directories that contain *old_name* in their names."""
+    # Walk bottom-up so we rename children before parents.
+    for dirpath, dirs, files in os.walk(root, topdown=False):
+        for fname in files:
+            if old_name in fname:
+                src = os.path.join(dirpath, fname)
+                dst = os.path.join(dirpath, fname.replace(old_name, new_name))
+                os.rename(src, dst)
+        for dname in dirs:
+            if old_name in dname:
+                src = os.path.join(dirpath, dname)
+                dst = os.path.join(dirpath, dname.replace(old_name, new_name))
+                os.rename(src, dst)
+
+
+# ---------------------------------------------------------------------------
+
+if __name__ == "__main__":
+    main()

biscuitcutter-1.0.0/biscuitcutter/examples.py

@@ -0,0 +1,6 @@
+# %%
+import biscuitcutter
+print(dir(biscuitcutter))
+print(biscuitcutter.__version__)
+
+# %%

biscuitcutter-1.0.0/biscuitcutter.egg-info/PKG-INFO

@@ -0,0 +1,130 @@
+Metadata-Version: 2.4
+Name: biscuitcutter
+Version: 1.0.0
+Summary: biscuitcutter – scaffold a new Python repo from a template in seconds.
+Author-email: Erdogan Taskesen <erdogant@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://erdogant.github.io/biscuitcutter
+Project-URL: Download, https://github.com/erdogant/biscuitcutter/archive/{version}.tar.gz
+Keywords: Python,biscuitcutter,templates,scaffolding,cookiecutter
+Classifier: Programming Language :: Python :: 3
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: Unix
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+[![Python](https://img.shields.io/pypi/pyversions/biscuitcutter)](https://img.shields.io/pypi/pyversions/biscuitcutter)
+[![Pypi](https://img.shields.io/pypi/v/biscuitcutter)](https://pypi.org/project/biscuitcutter/)
+[![Docs](https://img.shields.io/badge/Sphinx-Docs-Green)](https://erdogant.github.io/biscuitcutter/)
+[![LOC](https://sloc.xyz/github/erdogant/biscuitcutter/?category=code)](https://github.com/erdogant/biscuitcutter/)
+[![Downloads](https://static.pepy.tech/personalized-badge/biscuitcutter?period=month&units=international_system&left_color=grey&right_color=brightgreen&left_text=PyPI%20downloads/month)](https://pepy.tech/project/biscuitcutter)
+[![Downloads](https://static.pepy.tech/personalized-badge/biscuitcutter?period=total&units=international_system&left_color=grey&right_color=brightgreen&left_text=Downloads)](https://pepy.tech/project/biscuitcutter)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/erdogant/biscuitcutter/blob/master/LICENSE)
+[![Forks](https://img.shields.io/github/forks/erdogant/biscuitcutter.svg)](https://github.com/erdogant/biscuitcutter/network)
+[![Issues](https://img.shields.io/github/issues/erdogant/biscuitcutter.svg)](https://github.com/erdogant/biscuitcutter/issues)
+[![Project Status](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)
+
+<div>
+<a href="https://erdogant.github.io/biscuitcutter/">
+  <img src="https://raw.githubusercontent.com/erdogant/biscuitcutter/master/docs/figs/logo.png"
+       width="250"
+       align="left" />
+</a>
+<strong>biscuitcutter</strong> is a new repository scaffolder for Python projects.
+
+Create a new Python package or repository with a single command! ⭐️Star it if you like it⭐️
+</div>
+
+---
+
+### Key Features
+
+| Feature | Description |
+|--------|-------------|
+| [**Interactive CLI**](https://erdogant.github.io/biscuitcutter/pages/html/Installation.html) | Scaffold a new Python repository with prompts for repo name, author info, and more. |
+| [**Template-Based**](https://erdogant.github.io/biscuitcutter/) | Uses a pre-configured template to create a ready-to-use project structure. |
+| [**Placeholder Replacement**](https://erdogant.github.io/biscuitcutter/) | Automatically replaces placeholders (repo name, author, email, GitHub username) in all files. |
+
+---
+
+### Resources and Links
+- **Documentation:** [Website](https://erdogant.github.io/biscuitcutter)
+- **Bug Reports and Feature Requests:** [GitHub Issues](https://github.com/erdogant/biscuitcutter/issues)
+
+---
+
+### Installation
+
+##### Install biscuitcutter from PyPI
+```bash
+pip install biscuitcutter
+```
+---
+
+### Usage
+
+After installation, run the interactive CLI:
+
+```bash
+biscuitcutter
+```
+
+This will prompt you for:
+
+- **Repository / package name** (required)
+- **Author full name** (required)
+- **Author e-mail** (optional)
+- **GitHub username** (optional, defaults to lowercase author name without spaces)
+- **Parent directory** (optional, defaults to current directory)
+
+Alternatively, you can import and call the main function directly:
+
+```python
+from biscuitcutter import main
+main()
+```
+
+---
+
+### Example Session
+
+```console
+🍪  biscuitcutter – new repo scaffolder
+
+───────────────────────────────────────────
+  Repository / package name: my_project
+  Author full name: Erdogan Taskesen
+  Author e-mail: erdogant@gmail.com
+  GitHub username: erdogant
+  Parent directory (leave blank for current dir):
+
+✔  Created directory: /path/to/my_project
+✔  Template extracted to: /path/to/my_project
+✔  Placeholders replaced.
+
+🎉  Done!  Your new repo is ready at:
+    /path/to/my_project
+```
+
+---
+
+### Contributors
+
+Setting up and maintaining biscuitcutter has been possible thanks to users and contributors. Thanks to:
+
+<p align="left">
+  <a href="https://github.com/erdogant/biscuitcutter/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=erdogant/biscuitcutter" />
+  </a>
+</p>
+
+### Maintainer
+* Erdogan Taskesen, github: [erdogant](https://github.com/erdogant)
+* Contributions are welcome.

biscuitcutter-1.0.0/biscuitcutter.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+biscuitcutter/__init__.py
+biscuitcutter/biscuitcutter.py
+biscuitcutter/examples.py
+biscuitcutter/template.zip
+biscuitcutter.egg-info/PKG-INFO
+biscuitcutter.egg-info/SOURCES.txt
+biscuitcutter.egg-info/dependency_links.txt
+biscuitcutter.egg-info/entry_points.txt
+biscuitcutter.egg-info/top_level.txt

biscuitcutter-1.0.0/biscuitcutter.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

biscuitcutter-1.0.0/biscuitcutter.egg-info/entry_points.txt

@@ -0,0 +1,4 @@
+[console_scripts]
+bakebiscuit = biscuitcutter.biscuitcutter:main
+bakebiscuits = biscuitcutter.biscuitcutter:main
+biscuitcutter = biscuitcutter.biscuitcutter:main

biscuitcutter-1.0.0/biscuitcutter.egg-info/top_level.txt

@@ -0,0 +1 @@
+biscuitcutter

biscuitcutter-1.0.0/pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "biscuitcutter"
+dynamic = ["version"]
+authors = [{ name = "Erdogan Taskesen", email = "erdogant@gmail.com" }]
+description = "biscuitcutter – scaffold a new Python repo from a template in seconds."
+readme = "README.md"
+requires-python = ">=3.8"
+license = "MIT"
+keywords = ["Python", "biscuitcutter", "templates", "scaffolding", "cookiecutter"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Education",
+    "Intended Audience :: Science/Research",
+    "Operating System :: Unix",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: MacOS",
+    "Operating System :: OS Independent",
+]
+dependencies = []
+
+[project.urls]
+Homepage = "https://erdogant.github.io/biscuitcutter"
+Download = "https://github.com/erdogant/biscuitcutter/archive/{version}.tar.gz"
+
+# ── CLI entry-points ───────────────────────────────────────────────────────
+# After `pip install biscuitcutter` the user can type any of these commands
+# in a terminal to launch the interactive scaffolder.
+[project.scripts]
+biscuitcutter  = "biscuitcutter.biscuitcutter:main"
+bakebiscuit    = "biscuitcutter.biscuitcutter:main"
+bakebiscuits   = "biscuitcutter.biscuitcutter:main"
+
+[tool.setuptools]
+packages = ["biscuitcutter"]
+include-package-data = true
+
+[tool.setuptools.package-data]
+biscuitcutter = ["template.zip"]
+
+[tool.setuptools.dynamic]
+version = { attr = "biscuitcutter.__version__" }

biscuitcutter-1.0.0/setup.cfg

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