Skip to content

Commit 6e4ba6d

Browse files
authored
Update README.rst
1 parent 4af2005 commit 6e4ba6d

File tree

1 file changed

+12
-29
lines changed

1 file changed

+12
-29
lines changed

README.rst

Lines changed: 12 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,7 @@ ImportSpy addresses this challenge by enforcing a **declarative contract-driven
3737
- ✅ Eliminates debugging headaches by validating environments dynamically.
3838
- ✅ Gives you full control over how and where your code is used.
3939

40-
.. note::
41-
42-
"ImportSpy is not just a tool; it's a movement toward secure, auditable Python codebases."
40+
"**ImportSpy is not just a tool; it's a movement toward secure, auditable Python codebases.**"
4341

4442
🔴 Without vs 🟢 With ImportSpy
4543
-------------------------------
@@ -145,23 +143,13 @@ ImportSpy addresses this challenge by enforcing a **declarative contract-driven
145143
- 🔹 **Security-focused projects** that want to restrict runtime execution contexts
146144
- 🔹 **Python package maintainers** who need to validate runtime constraints for users
147145

148-
.. tip::
149-
150-
If your project relies on external modules, ImportSpy is your safeguard against execution chaos. 🔥
151-
152146
📦 Installation
153147
---------------
154148

155149
.. code-block:: bash
156150
157151
pip install importspy
158152
159-
Or, if using Poetry:
160-
161-
.. code-block:: bash
162-
163-
poetry add importspy
164-
165153
📚 Key Concepts
166154
---------------
167155

@@ -202,28 +190,23 @@ ImportSpy is built to improve the **resilience, auditability, and safety** of Py
202190
- 🛠 Developers: Build validators or tooling
203191
- 🏢 Companies: Enforce contracts at scale
204192
- 💡 CI engineers: Automate structural compliance
193+
Ways to Help 🚀
194+
~~~~~~~~~~~~~~~
205195

206-
💖 Support the Project
207-
----------------------
196+
- ⭐ **Star the project** on GitHub → `Give it a star! <https://github.com/atellaluca/ImportSpy>`_
197+
- 🛠️ **Contribute** → Open issues, PRs, or improve docs.
198+
- 📣 **Share ImportSpy** with developers who need execution control.
199+
- 💖 **Sponsor ImportSpy** to support development → `Become a sponsor <https://github.com/sponsors/atellaluca>`_.
208200

209-
Your sponsorship helps us:
201+
Every contribution helps make ImportSpy **better, stronger, and more useful**!
210202

211-
- Expand validation features
212-
- Improve docs and tutorials
213-
- Develop IDE extensions
203+
📜 License
204+
----------
214205

215-
👉 https://github.com/sponsors/atellaluca
206+
ImportSpy is released under the `MIT License <https://github.com/atellaluca/ImportSpy/blob/main/LICENSE>`_
216207

217208
📚 Learn More
218209
-------------
219-
220-
- `Installation <https://importspy.readthedocs.io/en/latest/get_started/installation.html>`__
221-
- `Contract Design <https://importspy.readthedocs.io/en/latest/overview/understanding_importspy/defining_import_contracts.html>`__
222-
- `Architecture <https://importspy.readthedocs.io/en/latest/advanced/architecture_index.html>`__
223-
224-
📦 Project Status
225-
-----------------
226-
227-
Launched in **October 2024**, ImportSpy is actively maintained and ready for production use.
210+
- 📖 **Documentation**: https://importspy.readthedocs.io/
228211

229212
🔥 Take control of your imports. Start using ImportSpy today! 🚀

0 commit comments

Comments
 (0)