instant-python 0.19.1__tar.gz → 0.21.0__tar.gz

{instant_python-0.19.1 → instant_python-0.21.0}/.github/actions/python_setup/action.yml

@@ -19,7 +19,5 @@ runs:
       shell: bash
 
     - name: 📦 Install dependencies
-      run: |
-        uv sync --all-groups
-        uv run -m pre_commit install --hook-type pre-commit --hook-type commit-msg --hook-type pre-push
+      run: make install
       shell: bash

{instant_python-0.19.1 → instant_python-0.21.0}/.github/workflows/ci.yml

@@ -31,7 +31,7 @@ jobs:
 
       - name: 🧐 Check linting
         id: check_lint
-        run: uvx ruff check --exclude "instant_python/templates,test/**/resources/**" instant_python test
+        run: make check-lint
 
   format:
     name: format
@@ -54,7 +54,7 @@ jobs:
 
       - name: 🧐 Check code format
         id: check_format
-        run: uvx ruff format --check --exclude "instant_python/templates,test/**/resources/**" instant_python test
+        run: make check-format
 
   analyze-code-quality:
     name: analyze-code-quality

{instant_python-0.19.1 → instant_python-0.21.0}/.pre-commit-config.yaml

@@ -44,7 +44,7 @@ repos:
     hooks:
       - id: gitleaks
         name: 🔍 Secrets Checker
-        entry: gitleaks detect --no-git --redact --verbose
+        entry: gitleaks detect --redact --verbose
         stages:
           - pre-commit
 

{instant_python-0.19.1 → instant_python-0.21.0}/CHANGELOG.md

@@ -2,6 +2,274 @@
 
 <!-- version list -->
 
+## v0.21.0 (2025-12-12)
+
+### ✨ Features
+
+- **metrics**: Set default values for api_key and host in PostHogConfig
+  ([`8cfd3c2`](https://github.com/dimanu-py/instant-python/commit/8cfd3c23ebe08ec54bb06d8ed7f646a7d8105a13))
+
+- **metrics**: Add metrics disabled check in PostHogMetricsReporter to prevent sending metrics when
+  disabled
+  ([`11e3cd3`](https://github.com/dimanu-py/instant-python/commit/11e3cd3f8a5e97065e54bf2d101647fb59d913a8))
+
+- **config**: Add metrics_enabled field to configuration for controlling metrics collection
+  ([`841cd9f`](https://github.com/dimanu-py/instant-python/commit/841cd9f73a8d6aa779a05f48cc160fe5f33d0123))
+
+- **metrics**: Add error metrics handling in metrics middleware for improved exception tracking
+  ([`7192e88`](https://github.com/dimanu-py/instant-python/commit/7192e88fc6c294065bd2c4d74223f0de552c0d6b))
+
+- **metrics**: Implement error handling in send_error method for capturing exceptions
+  ([`49d227f`](https://github.com/dimanu-py/instant-python/commit/49d227f700de0a550e7849a169f146df7fc33cde))
+
+- **metrics**: Add error handling for command failures in usage metrics sender
+  ([`364a731`](https://github.com/dimanu-py/instant-python/commit/364a7317b0ed8c08a29d7525f98366eae7715835))
+
+- **metrics**: Create class to store all data related to error event
+  ([`8174b3f`](https://github.com/dimanu-py/instant-python/commit/8174b3fc9f975cd338aeefcc0b28fb0cad86c180))
+
+- **metrics**: Add send_error method to metrics reporter for error handling
+  ([`c3e2cdb`](https://github.com/dimanu-py/instant-python/commit/c3e2cdb6676c23c8476cb222f7d37c0de1b05a84))
+
+- **metrics**: Add ConfigSnapshotPrimitives type and to_primitives method
+  ([`eb28115`](https://github.com/dimanu-py/instant-python/commit/eb28115bd5a3a62c3996d03fdc5f4fc3daadd168))
+
+- **metrics**: Add snapshot creator instance inside metrics middleware
+  ([`a7f4984`](https://github.com/dimanu-py/instant-python/commit/a7f498437b503bf956ed9f40b95f1c6ebf9deaf2))
+
+- **metrics**: Add method to create unknown ConfigSnapshot and handle missing config file
+  ([`4e17a87`](https://github.com/dimanu-py/instant-python/commit/4e17a8750b2c3d292da8d3280a4f25a4f521abda))
+
+- **metrics**: Implement method to be able to compare two snapshots
+  ([`ec00d47`](https://github.com/dimanu-py/instant-python/commit/ec00d47167a5a47bb34394ce02a2fc663f542fb9))
+
+- **metrics**: Implement 'is_unknown' method in config snapshot class to determine if it has been
+  properly read or not
+  ([`910c8d1`](https://github.com/dimanu-py/instant-python/commit/910c8d1502fa076167092ecad57dfd93314a9ccf))
+
+- **metrics**: Implement use case to create a snapshot of the configuration file
+  ([`4ab1892`](https://github.com/dimanu-py/instant-python/commit/4ab18922bb15f5e73353ee646baa8be339445494))
+
+- **shared**: Add 'for_metrics' method in config schema to be able to get only the data I need for
+  metrics and not need to access all the internals of the class
+  ([`feb27b7`](https://github.com/dimanu-py/instant-python/commit/feb27b77e9feab6c4a2b37bc5c790fb83544a2a2))
+
+- **metrics**: Inject config repository to snapshot creator to be able to read an existing
+  configuration file
+  ([`e10e26c`](https://github.com/dimanu-py/instant-python/commit/e10e26cc0d46c46895cd4551897994a88f64008e))
+
+- **metrics**: Create config snapshot class to store all the data related to the config file that
+  will be sent to metrics
+  ([`32db003`](https://github.com/dimanu-py/instant-python/commit/32db00308a09cecf12aa202574ad9e1a3f945d3b))
+
+- **metrics**: Integrate MetricsMiddleware into InstantPythonTyper for enhanced command execution
+  metrics
+  ([`2b9db62`](https://github.com/dimanu-py/instant-python/commit/2b9db621867a196018afd6348c78e2b2adf0559a))
+
+- **metrics**: Add MetricsMiddleware to handle command execution and send usage metrics data after
+  command execution has finished
+  ([`bdbbe00`](https://github.com/dimanu-py/instant-python/commit/bdbbe000e191ab72ca5c0eda97ba8a364346b5b4))
+
+- **metrics**: Implement execute method in metrics sender use case to send usage metrics data
+  ([`2fbecb8`](https://github.com/dimanu-py/instant-python/commit/2fbecb804c15b95228df6612abaadc5a74e50ef1))
+
+- **metrics**: Validate distinct ID format when loading from metrics file
+  ([`007c9d2`](https://github.com/dimanu-py/instant-python/commit/007c9d2958082d4b15d96eb0f5c0a4666153e24a))
+
+- **metrics**: Handle JSON decoding errors and missing distinct ID in metrics file
+  ([`c2e6be6`](https://github.com/dimanu-py/instant-python/commit/c2e6be60a8191b710402356daddac43c6cb8f30b))
+
+- **metrics**: Retrieve distinct ID from metrics.json if it exists so an existing user does not
+  generate a new id
+  ([`9b52f46`](https://github.com/dimanu-py/instant-python/commit/9b52f469598ee8b197448693e4a94e91f8396ab1))
+
+- **metrics**: Store distinct ID in metrics.json on first execution
+  ([`da050c9`](https://github.com/dimanu-py/instant-python/commit/da050c94e57653fe56ad09e5aee3704d6e3638fb))
+
+- **metrics**: Add UserIdentityManager to generate distinct user IDs
+  ([`36ef740`](https://github.com/dimanu-py/instant-python/commit/36ef7401467d4b20502e0c6d19cc80ffe8e0c588))
+
+- **metrics**: Implement fire-and-forget strategy for metric sending
+  ([`6cc0761`](https://github.com/dimanu-py/instant-python/commit/6cc0761a8ca86d15472448f03724105cdb4e47e2))
+
+- **metrics**: Enable sync mode for PostHog client initialization
+  ([`51c52bc`](https://github.com/dimanu-py/instant-python/commit/51c52bc235f16a70c5f646d3445fecc889063d78))
+
+- **metrics**: Capture event to be sent to posthog using a temporary distinct_id
+  ([`db27119`](https://github.com/dimanu-py/instant-python/commit/db27119b567f438caf5444b0cc91e0a7872d85f1))
+
+- **metrics**: Create posthog client inside reporter to be able to send metrics
+  ([`59aa393`](https://github.com/dimanu-py/instant-python/commit/59aa3938c5c9c29af31b5f52f21245c5d0a058c5))
+
+- **metrics**: Create post hog config class to handle env variables related with post hog
+  ([`95a4516`](https://github.com/dimanu-py/instant-python/commit/95a4516df3defeb2f0b528b1a08d4f0426586869))
+
+- **metrics**: Create dataclass to store all data related to usage metrics that will be send to
+  posthog
+  ([`0368a98`](https://github.com/dimanu-py/instant-python/commit/0368a98c71f82ab96db4e4bcb23e6142f6c3703a))
+
+### ⚙️ Build System
+
+- **pyproject**: Add platformdirs as production dependency as it's not built-in with all supported
+  python versions
+  ([`ef5dcf3`](https://github.com/dimanu-py/instant-python/commit/ef5dcf34c9b1b9c6f16e6a0e83f29d67898a6694))
+
+- **pyproject**: Update dependencies to remove vulnerability
+  ([`c858003`](https://github.com/dimanu-py/instant-python/commit/c858003272d4516a6b13e11f478a2cb9f2de895b))
+
+- **pyproject**: Add vcr dependency to run posthog integration test without affecting current
+  project
+  ([`ccc11f0`](https://github.com/dimanu-py/instant-python/commit/ccc11f011ffe615c3b581c89de68db774c353033))
+
+- **pyproject**: Add pydantic settings dependency to handle env variables gracefully
+  ([`0b8b19f`](https://github.com/dimanu-py/instant-python/commit/0b8b19fd7c315403f134c08272ca5ad9f0d0813f))
+
+### ♻️ Refactoring
+
+- **metrics**: Streamline success metrics handling in metrics middleware
+  ([`65962b6`](https://github.com/dimanu-py/instant-python/commit/65962b630f2b049b0aec1336991dc79cf4757587))
+
+- **metrics**: Update send_error method to include error parameter
+  ([`61210ac`](https://github.com/dimanu-py/instant-python/commit/61210acf4724a307a3b838821a59e00c06b97e87))
+
+- **metrics**: Rename send method to send_success in metrics reporter
+  ([`462db4c`](https://github.com/dimanu-py/instant-python/commit/462db4c55778647dc82fe7095cb20a5712083951))
+
+- **metrics**: Rename execute method to execute_on_success
+  ([`ac34809`](https://github.com/dimanu-py/instant-python/commit/ac34809dc85437768c9db23e429ddf44e2b622b5))
+
+- **metrics**: Modify metrics middleware to take config snapshots to avoid errors when init command
+  finished its execution and config file is moved
+  ([`0716f62`](https://github.com/dimanu-py/instant-python/commit/0716f62fc01aaf4c598e3580714110fcb9807fbd))
+
+- **metrics**: Enhance UsageMetricsEvent with dependency_manager and adjust built_in_features
+  initialization
+  ([`0281909`](https://github.com/dimanu-py/instant-python/commit/0281909b089a0bbfab5dc46dc8d0088e7ab0e59d))
+
+- **metrics**: Update execute method to accept config_snapshot parameter and not need to read
+  configuration file
+  ([`ee03fc9`](https://github.com/dimanu-py/instant-python/commit/ee03fc9cb1e1c391caf0d650dbbe9514eaef9131))
+
+- **metrics**: Rename UsageMetricsData to UsageMetricsEvent for clarity
+  ([`24a47ab`](https://github.com/dimanu-py/instant-python/commit/24a47ab97fc30bd7f9ad43a4acbb6a3573b1dacc))
+
+- **metrics**: Simplify UsageMetricsSender initialization by removing repository parameter
+  ([`e5d5917`](https://github.com/dimanu-py/instant-python/commit/e5d5917df1044368f709183b0d5fa0a2c0bf41aa))
+
+- **metrics**: Rename method to improve clarity in config reading
+  ([`9468e1a`](https://github.com/dimanu-py/instant-python/commit/9468e1a4ed7d96ef69c4eae1b4a52f712fdb37b9))
+
+- **metrics**: Update ConfigSnapshotCreator to utilize for_metrics method for improved config
+  handling
+  ([`2ce0140`](https://github.com/dimanu-py/instant-python/commit/2ce0140eda8234fdcf722b7d0ef3c48ee612ce59))
+
+- **config**: Improve error handling in configuration file loading
+  ([`1114c17`](https://github.com/dimanu-py/instant-python/commit/1114c17d570b989d85245dd0a032aeaf2a9af9f5))
+
+- **metrics**: Extract configuration data handling into a separate method and streamline metrics
+  data creation
+  ([`e316523`](https://github.com/dimanu-py/instant-python/commit/e31652391e93f7da8c254a4e8283792eeb62f63e))
+
+- **metrics**: Simplify execute method by removing success and error message parameters now that it
+  will be handled automatically by posthog reporter
+  ([`77469a9`](https://github.com/dimanu-py/instant-python/commit/77469a93fb411ef5ce6c8d000b25da1d2c9bc700))
+
+- **metrics**: Rename get_distinct_id method to get_or_create_distinct_id for clarity
+  ([`0a068c7`](https://github.com/dimanu-py/instant-python/commit/0a068c7e6903e00a590d76b058510627108be592))
+
+- **metrics**: Rename metric reporter classes for consistency
+  ([`15f122f`](https://github.com/dimanu-py/instant-python/commit/15f122f472c3e270e2ec3461be626c9b874eb12d))
+
+- **metrics**: Remove success an error message data from metrics object as posthog is configured to
+  report errors automatically
+  ([`0f4eb0b`](https://github.com/dimanu-py/instant-python/commit/0f4eb0b94f5fbe63477a8da6586ad39d74219125))
+
+- **metrics**: Update post hog metric reporter to use user identity manager and create consistent
+  distinct ids
+  ([`b5ad406`](https://github.com/dimanu-py/instant-python/commit/b5ad406236641adaad3590a767245caad610427f))
+
+- **metrics**: Set config dir to be the .config folder of user system if is not passed and extract
+  named variables to improve readability
+  ([`2e54e8e`](https://github.com/dimanu-py/instant-python/commit/2e54e8edc72ca118f47222302d4fa6c2c2e94556))
+
+- **metrics**: Modify distinct ID handling to improve readability and maintainability
+  ([`aa8d52b`](https://github.com/dimanu-py/instant-python/commit/aa8d52b462f486c47a72a3c33cc2d392ae726249))
+
+- **metrics**: Use usage metrics data class for send method in metric reporter
+  ([`96393c2`](https://github.com/dimanu-py/instant-python/commit/96393c27088fbfb691b9c0fbb205bdd31f609ad2))
+
+
+## v0.20.0 (2025-12-05)
+
+### ✨ Features
+
+- **schema**: Add JSON schema for custom project template structure to enable syntax and key/value
+  detection
+  ([`bf918b5`](https://github.com/dimanu-py/instant-python/commit/bf918b5b1efdcb9ddc38786814a5038144ca958b))
+
+- **schema**: Add JSON schema for instant-python project configuration to enable syntax and
+  key/value detection when modifying ipy config file manually
+  ([`2e3d4f7`](https://github.com/dimanu-py/instant-python/commit/2e3d4f786020ead95324784497015e698477a891))
+
+- **templates**: Add autostyle command to makefile to automatically format, lint and commit modified
+  files
+  ([`96c4610`](https://github.com/dimanu-py/instant-python/commit/96c46109c811198b70598df2c9f3e0674f6be1e7))
+
+- **initialize**: Implement 'write' method in yaml config repository to be able to write ipy config
+  file in working directory
+  ([`ca04b4c`](https://github.com/dimanu-py/instant-python/commit/ca04b4c97392970399ed7b8a6e3a86984ed6779b))
+
+- **initialize**: Add 'write' method to config repository to be able to use it with config command
+  and move it to shared
+  ([`e081a34`](https://github.com/dimanu-py/instant-python/commit/e081a342ccac66e45cef0cad728681c5aa9f301d))
+
+### ⚙️ Build System
+
+- **makefile**: Add command to makefile to automatically format, lint and commit modified files
+  ([`2837703`](https://github.com/dimanu-py/instant-python/commit/28377039628f755b503192aef85723f3e3b4704c))
+
+- **pyproject**: Add posthog dependency
+  ([`b3df1c0`](https://github.com/dimanu-py/instant-python/commit/b3df1c0587709a39e9e702142bdad4e8e293b07a))
+
+- **makefile**: Modify add-dep and remove-dep commands in makefile to not need scripts files
+  ([`b9d5286`](https://github.com/dimanu-py/instant-python/commit/b9d528636f5a051c865f4ea45196443ff322b55e))
+
+### ♻️ Refactoring
+
+- **templates**: Rename all templates for project structure to remove the '.j2' extension as it is
+  not need it
+  ([`cde9f87`](https://github.com/dimanu-py/instant-python/commit/cde9f87670273e6711fd08919c525208e7075fd9))
+
+- **initialize**: Modify file name for project structure template to not include j2 extension
+  ([`e8cd1f1`](https://github.com/dimanu-py/instant-python/commit/e8cd1f1aadb637f0a359783f11f95b164ca4cbd8))
+
+- **cli**: Modify main callback to print ipy help if no subcommand is called
+  ([`1784a3d`](https://github.com/dimanu-py/instant-python/commit/1784a3d129253cd197640680fbd85351ff074ec8))
+
+- **initialize**: Move config repository port and its adapter to shared folder so it can be properly
+  shared among commands
+  ([`438f89c`](https://github.com/dimanu-py/instant-python/commit/438f89cdf75ff58ce0477e88a54cad55ad4e93ae))
+
+- **config**: Remove legacy config writer now that its behavior has been unified in the config
+  repository
+  ([`3bcd3c9`](https://github.com/dimanu-py/instant-python/commit/3bcd3c9d858e342d9deca9bdc7bcd5db766de94b))
+
+- **config**: Extract semantic method to keep use case with the same abstraction level and make it
+  more readable
+  ([`7077e6a`](https://github.com/dimanu-py/instant-python/commit/7077e6a50a23df5e3d080b89265a935d83d8d68c))
+
+- **config**: Modify config generator dependency to receive a config repository instead of a config
+  writer
+  ([`89ed351`](https://github.com/dimanu-py/instant-python/commit/89ed35135d679a4fb4375eece5329162c454fb91))
+
+- **initialize**: Modify 'write' method so it uses absolute config file path instead of creating it
+  ([`5acc795`](https://github.com/dimanu-py/instant-python/commit/5acc795ba127292d5144d18da3ba718faf880b9e))
+
+- **shared**: Make default config file path absolute from users root folder to avoid incorrect
+  destination and relative path errors
+  ([`074e4a7`](https://github.com/dimanu-py/instant-python/commit/074e4a76f5319f2d167243935ca449a3ff80ca10))
+
+
 ## v0.19.1 (2025-11-27)
 
 ### 🪲 Bug Fixes

{instant_python-0.19.1 → instant_python-0.21.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: instant-python
-Version: 0.19.1
+Version: 0.21.0
 Summary: Instant boilerplate generation for Python projects
 Project-URL: documentation, https://dimanu-py.github.io/instant-python/
 Project-URL: repository, https://github.com/dimanu-py/instant-python/
@@ -220,6 +220,9 @@ Classifier: Topic :: System :: Installation/Setup
 Classifier: Topic :: System :: Shells
 Requires-Python: >=3.9
 Requires-Dist: jinja2>=3.1.6
+Requires-Dist: platformdirs>=4.4.0
+Requires-Dist: posthog>=6.9.3
+Requires-Dist: pydantic-settings>=2.11.0
 Requires-Dist: pyyaml>=6.0.2
 Requires-Dist: questionary>=2.1.0
 Requires-Dist: typer>=0.15.1
@@ -280,10 +283,12 @@ so can quickly find what you need.
 
 - [Installation]: begin by learning how to install `instant-python`.
 - [First Steps]: get started with the basic features of `instant-python`.
+- [Privacy & Metrics]: learn about the anonymous usage data we collect and how to opt out.
 - [Advanced Usage and Customization]: explore advanced features and customization options.
 
 [Installation]: https://dimanu-py.github.io/instant-python/getting_started/installation/
 [First Steps]: https://dimanu-py.github.io/instant-python/getting_started/first_steps/
+[Privacy & Metrics]: https://dimanu-py.github.io/instant-python/getting_started/privacy_and_metrics/
 [Advanced Usage and Customization]: https://dimanu-py.github.io/instant-python/guide/
 
 ### For Developers
@@ -304,14 +309,23 @@ so can quickly find what you need.
 [GitHub Discussions]: https://github.com/dimanu-py/instant-python/discussions
 [GitHub Issues]: https://github.com/dimanu-py/instant-python/issues
 
-[//]: # (### Do Not Track)
+## 🔒 Privacy & Usage Metrics
 
-[//]: # ()
-[//]: # (In order to get better insights about the usage of the library, we collect anonymous usage data. The only)
+To improve `instant-python` and provide a better experience, we collect **anonymous usage metrics**. 
+No personal or sensitive information is collected.
 
-[//]: # (data we collect is the commands you run. No personal data is collected as part of this request.)
+**What we collect:**
+- Command executed and IPY version
+- Operating system type
+- Python version, dependency manager, and template choices
+- Error types (when commands fail)
 
-[//]: # ()
-[//]: # (You can disable this feature by setting the environment variable `INSTANT_PYTHON_NO_TRACK` to `1` or )
+**What we DON'T collect:**
+- No file paths, project names, or code content
+- No personal information or IP addresses
+
+**How to opt out:**
+Set the environment variable `IPY_METRICS_ENABLE=false`
+
+For complete details, see our [Privacy & Metrics documentation](https://dimanu-py.github.io/instant-python/getting_started/privacy_and_metrics/).
 
-[//]: # (passing the `--no-track` option to any command.)

{instant_python-0.19.1 → instant_python-0.21.0}/README.md

@@ -51,10 +51,12 @@ so can quickly find what you need.
 
 - [Installation]: begin by learning how to install `instant-python`.
 - [First Steps]: get started with the basic features of `instant-python`.
+- [Privacy & Metrics]: learn about the anonymous usage data we collect and how to opt out.
 - [Advanced Usage and Customization]: explore advanced features and customization options.
 
 [Installation]: https://dimanu-py.github.io/instant-python/getting_started/installation/
 [First Steps]: https://dimanu-py.github.io/instant-python/getting_started/first_steps/
+[Privacy & Metrics]: https://dimanu-py.github.io/instant-python/getting_started/privacy_and_metrics/
 [Advanced Usage and Customization]: https://dimanu-py.github.io/instant-python/guide/
 
 ### For Developers
@@ -75,14 +77,23 @@ so can quickly find what you need.
 [GitHub Discussions]: https://github.com/dimanu-py/instant-python/discussions
 [GitHub Issues]: https://github.com/dimanu-py/instant-python/issues
 
-[//]: # (### Do Not Track)
+## 🔒 Privacy & Usage Metrics
 
-[//]: # ()
-[//]: # (In order to get better insights about the usage of the library, we collect anonymous usage data. The only)
+To improve `instant-python` and provide a better experience, we collect **anonymous usage metrics**. 
+No personal or sensitive information is collected.
 
-[//]: # (data we collect is the commands you run. No personal data is collected as part of this request.)
+**What we collect:**
+- Command executed and IPY version
+- Operating system type
+- Python version, dependency manager, and template choices
+- Error types (when commands fail)
 
-[//]: # ()
-[//]: # (You can disable this feature by setting the environment variable `INSTANT_PYTHON_NO_TRACK` to `1` or )
+**What we DON'T collect:**
+- No file paths, project names, or code content
+- No personal information or IP addresses
+
+**How to opt out:**
+Set the environment variable `IPY_METRICS_ENABLE=false`
+
+For complete details, see our [Privacy & Metrics documentation](https://dimanu-py.github.io/instant-python/getting_started/privacy_and_metrics/).
 
-[//]: # (passing the `--no-track` option to any command.)

instant_python-0.21.0/docs/getting_started/privacy_and_metrics.md

@@ -0,0 +1,137 @@
+# Privacy and Usage Metrics
+
+!!! info "Anonymous Usage Data"
+    To improve `instant-python` and provide a better experience to all users, we collect **anonymous usage metrics**.
+    No personal or sensitive information is collected. 
+
+This page explains what data we collect, why we collect it, and how to disable it if you prefer.
+
+## Why We Collect Metrics
+
+We collect anonymous usage data to:
+
+- 📊 **Understand which features are most used** - This helps us prioritize improvements and new features
+- 🐛 **Identify common errors** - We can proactively fix bugs that users encounter
+- 🚀 **Improve user experience** - By understanding how people use the tool, we can make it better
+- 📈 **Make data-driven decisions** - We can focus our efforts on what matters most to the community
+
+**Your privacy is important to us.** We only collect the minimum data necessary to achieve these goals,
+and we never collect personal information like file paths, project names, or any code content.
+
+## What Data We Collect
+
+### On Successful Command Execution
+
+When you successfully run an `ipy` command, we collect:
+
+| Data Field | Description | Example                                      |
+|------------|-------------|----------------------------------------------|
+| `ipy_version` | The version of instant-python you're using | `0.20.0`                                     |
+| `operating_system` | Your operating system | `Linux`, `Darwin`, `Windows`                 |
+| `command` | The command you executed | `config`, `init`                             |
+| `python_version` | The Python version you configured | `3.12`                                       |
+| `dependency_manager` | The package manager you selected | `pdm`, `uv`                                  |
+| `template` | The project template you chose | `domain_driven_design`, `clean_architecture` |
+| `built_in_features` | List of features you enabled | `["makefile", "value_objects"]`               |
+
+### On Command Errors
+
+When a command fails with an error, we collect:
+
+| Data Field | Description | Example |
+|------------|-------------|---------|
+| `ipy_version` | The version of instant-python you're using | `1.2.3` |
+| `operating_system` | Your operating system | `Linux`, `Darwin`, `Windows` |
+| `command` | The command that failed | `config`, `init` |
+| `error_type` | The type of error that occurred | `FileNotFoundError`, `ValueError` |
+| `error_message` | The error message | `Configuration file not found` |
+
+## What We DON'T Collect
+
+We want to be transparent about what we **do not** collect:
+
+- ❌ **No personal information** - We don't collect your name, email, IP address, or any identifiable information
+- ❌ **No file paths** - We never collect the paths where you create projects
+- ❌ **No project names** - Your project names remain completely private
+- ❌ **No code content** - We never collect any of your code or file contents
+- ❌ **No environment variables** - Except for the opt-out flag, we don't read your environment
+
+## How to Disable Metrics Collection
+
+If you prefer not to send usage metrics, you can easily disable this feature.
+
+Set the `IPY_METRICS_ENABLE` environment variable to `false` or `0`:
+
+### Linux/macOS
+
+- Bash/Zsh:
+    
+    For a single command run:
+
+    ```bash
+    IPY_METRICS_ENABLE=false ipy config
+    ```
+  
+    Permanently in your shell profile (_~/.bashrc_, _~/.zshrc_, etc.)
+    
+    ```bash
+    export IPY_METRICS_ENABLE=false
+    ```
+
+- Fish:
+
+    For a single command run:
+
+    ```bash
+    env IPY_METRICS_ENABLE=false ipy config
+    ```
+    
+    Permanently in your shell profile (_~/.config/fish/config.fish_)
+    
+    ```fish
+    set -Ux IPY_METRICS_ENABLE false
+    ```
+
+### Windows
+
+- PowerShell
+
+    For a single command:
+
+    ```powershell
+    $env:IPY_METRICS_ENABLE="false"; ipy config
+    ```
+    
+    Permanently for the current user:
+
+    ```powershell
+    [Environment]::SetEnvironmentVariable("IPY_METRICS_ENABLE", "false", "User")
+    ```
+
+- CMD
+    
+    For a single command
+    ```cmd
+    set IPY_METRICS_ENABLE=false && ipy config
+    ```
+    
+    Permanently for the current user:
+
+    ```cmd
+    setx IPY_METRICS_ENABLE "false"
+    ```
+
+## Questions or Concerns?
+
+If you have any questions or concerns about our data collection practices:
+
+- 💬 Start a discussion on [GitHub Discussions]
+- 🐛 Report issues on [GitHub Issues]
+- 🔒 For security concerns, see our [Security Policy]
+
+We're committed to transparency and respect for your privacy. Thank you for helping us improve `instant-python`!
+
+[GitHub Discussions]: https://github.com/dimanu-py/instant-python/discussions
+[GitHub Issues]: https://github.com/dimanu-py/instant-python/issues
+[Security Policy]: ../development/security.md
+

{instant_python-0.19.1 → instant_python-0.21.0}/docs/guide/command_config.md

@@ -9,6 +9,7 @@ project.
 
 - [Overview](#overview) - What the config command does
 - [Usage](#usage) - How to run the config command
+- [JSON Schema Support](#json-schema-support) - IDE autocompletion and validation
 - [Configuration File Structure](#configuration-file-structure-and-restrictions) - All available options and their restrictions
     - [General](#general) - Project metadata
     - [Template](#template) - Project structure and features
@@ -113,6 +114,69 @@ Each dependency can have the following fields and restrictions:
 | `development` | Whether the dependency is a development dependency. | Must be either `true` or `false`.          | No                    |
 | `group`      | The development dependency group.                 | Only available if `development` is `true`. | Based on restrictions |
 
+## JSON Schema Support
+
+`instant-python` provides a JSON Schema to help you write and validate your configuration files with autocompletion and validation in your IDE.
+
+### What is a JSON Schema?
+
+A JSON Schema is a specification that defines the structure and validation rules for JSON and YAML files. By using a schema, your IDE can:
+
+- **Autocomplete** field names and values
+- **Validate** your configuration in real-time
+- **Show inline documentation** for each field
+- **Detect errors** before running the command
+
+### How to Use the Schema
+
+The schema is available at:
+```
+https://raw.githubusercontent.com/dimanu-py/instant-python/main/schemas/ipy-schema.json
+```
+
+!!! tip "Schema autodetection"
+If your configuration file is named `ipy.yml`, some IDEs may automatically detect and apply the schema
+from [SchemaStore](https://www.schemastore.org/). However, as it may take some time to updated and listed there,
+we recommend configuring it manually to ensure you are using the latest version.
+
+#### For Visual Studio Code
+
+Add the following line at the top of your `ipy.yml` file:
+
+```yaml
+# yaml-language-server: $schema=https://raw.githubusercontent.com/dimanu-py/instant-python/main/schemas/ipy-schema.json
+
+general:
+  slug: my-project
+  # ...
+```
+
+Alternatively, you can configure it globally in your VS Code settings (`.vscode/settings.json`):
+
+```json
+{
+  "yaml.schemas": {
+    "https://raw.githubusercontent.com/dimanu-py/instant-python/main/schemas/ipy-schema.json": "ipy.yml"
+  }
+}
+```
+
+#### For PyCharm / IntelliJ IDEA
+
+1. Open your `ipy.yml` file
+2. At the top of the file, add:
+   ```yaml
+   # yaml-language-server: $schema=https://raw.githubusercontent.com/dimanu-py/instant-python/main/schemas/ipy-schema.json
+   ```
+3. PyCharm will automatically detect and use the schema
+
+Alternatively, you can configure it manually:
+
+1. Go to **Settings** → **Languages & Frameworks** → **Schemas and DTDs** → **JSON Schema Mappings**
+2. Click the **+** button to add a new mapping
+3. Set the **Schema URL** to: `https://raw.githubusercontent.com/dimanu-py/instant-python/main/schemas/ipy-schema.json`
+4. Add a file pattern: `ipy.yml`
+
 ## Configuration File Examples
 
 ### Without initializing a git repository