Metadata-Version: 2.1
Name: drcodecover
Version: 1.0.1
Summary: A special package for Sentry integration with advanced configuration options.
Home-page: https://github.com/codewithnadeem14502/drcode-wrapper-python
Author: Mohd Nadeem
Author-email: codewithnadeem@gmail.com
Project-URL: Documentation, https://github.com/codewithnadeem14502/drcode-wrapper-python#readme
Project-URL: Source, https://github.com/codewithnadeem14502/drcode-wrapper-python
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: sentry-sdk>=2.0.0

<h3 id="drcodecover">drcodecover</h3>
<p><strong>drcodecover</strong> is a Python package that provides a wrapper around Sentry, making it easy to configure and use Sentry&#39;s features, including profiling and error handling.</p>
<h2 id="installation">Installation</h2>
<p>To install the package, run:</p>
<p>bash</p>
<h2 id="copy-code--pip-install-drcodecover--getting-started">Copy code
<pre><code class="language-const"> pip install drcodecover
</code></pre>
Getting Started</h2>
<p><strong>Basic Usage</strong></p>
<p>python</p>
<p>Copy code</p>
<pre><code class="language-const"> 
from drcodecover import init_drcode
config = {
'protocol': 'https',
'public_key': 'yourPublicKey',
'host': 'sentry.io',
'port': 443,
'project_id': 'yourProjectId',
'traces_sample_rate': 1.0, # optional
'profiles_sample_rate': 1.0 # optional
}
init_drcode(config)

</code></pre></p>

<h2 id="configuration">Configuration</h2>
<p><strong>Configuration Object</strong></p>
<ul>
<li><code>public_key</code> (str): The public key for Sentry.</li>
<li><code>project_id</code> (str): The Sentry project ID.</li>
<li><code>traces_sample_rate</code> (float, optional): The sample rate for tracing (default: 1.0).</li>
<li><code>profiles_sample_rate</code> (float, optional): The sample rate for profiling (default: 1.0).</li>
</ul>
<h2 id="api-reference">API Reference</h2>
<p><strong>Functions</strong></p>
<ul>
<li><p><strong>init_drcode(config: dict) -&gt; None</strong></p>
<p>Initializes Sentry with the provided configuration.</p>
<ul>
<li><strong>config</strong> (dict): The configuration dictionary.</li>
</ul>
</li>
</ul>
<p><strong>Configuration Dictionary</strong></p>
<p>The configuration dictionary should contain the following keys:</p>
<ul>
<li><code>public_key</code> (str): The public key for Sentry.</li>
<li><code>project_id</code> (str): The Sentry project ID.</li>
<li><code>traces_sample_rate</code> (float, optional): The sample rate for tracing (default: 1.0).</li>
<li><code>profiles_sample_rate</code> (float, optional): The sample rate for profiling (default: 1.0).</li>
</ul>
<h2 id="license">License</h2>
<p>This project is licensed under the MIT License.</p>
<h2 id="version">Version</h2>
<p>1.0.0</p>
