| Server IP : 46.101.140.223 / Your IP : 216.73.216.134 Web Server : nginx/1.22.1 System : Linux debian-s-1vcpu-1gb-fra1-01 6.1.0-49-amd64 #1 SMP PREEMPT_DYNAMIC Debian 6.1.174-1 (2026-05-26) x86_64 User : deploy-others ( 1001) PHP Version : 8.2.32 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : OFF | Sudo : ON | Pkexec : OFF Directory : /usr/share/doc/python3-watchdog/html/ |
Upload File : |
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>Contributing — watchdog 2.2.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/pyramid.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="API Reference" href="api.html" />
<!--[if lte IE 6]>
<link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" />
<![endif]-->
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="api.html" title="API Reference"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">watchdog 2.2.1 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Contributing</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="contributing">
<span id="hacking"></span><h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this heading">¶</a></h1>
<p>Welcome hacker! So you have got something you would like to see in
<code class="docutils literal notranslate"><span class="pre">watchdog</span></code>? Whee. This document will help you get started.</p>
<section id="important-urls">
<h2>Important URLs<a class="headerlink" href="#important-urls" title="Permalink to this heading">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">watchdog</span></code> uses <a class="reference external" href="https://git-scm.org/">git</a> to track code history and hosts its <a class="reference external" href="https://github.com/gorakhargosh/watchdog">code repository</a>
at <a class="reference external" href="https://github.com/">github</a>. The <a class="reference external" href="https://github.com/gorakhargosh/watchdog/issues">issue tracker</a> is where you can file bug reports and request
features or enhancements to <code class="docutils literal notranslate"><span class="pre">watchdog</span></code>.</p>
</section>
<section id="before-you-start">
<h2>Before you start<a class="headerlink" href="#before-you-start" title="Permalink to this heading">¶</a></h2>
<p>Ensure your system has the following programs and libraries installed before
beginning to hack:</p>
<ol class="arabic simple">
<li><p><a class="reference external" href="https://python.org">Python</a></p></li>
<li><p><a class="reference external" href="https://git-scm.org/">git</a></p></li>
<li><p><a class="reference external" href="https://developer.apple.com/technologies/tools/xcode.html">XCode</a> (on macOS)</p></li>
</ol>
</section>
<section id="setting-up-the-work-environment">
<h2>Setting up the Work Environment<a class="headerlink" href="#setting-up-the-work-environment" title="Permalink to this heading">¶</a></h2>
<p>Steps to setting up a clean environment:</p>
<ol class="arabic simple">
<li><p>Fork the <a class="reference external" href="https://github.com/gorakhargosh/watchdog">code repository</a> into your <a class="reference external" href="https://github.com/">github</a> account.</p></li>
<li><p>Clone fork and create virtual environment:</p></li>
</ol>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com//watchdog.git
$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>watchdog
$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>virtualenv
$<span class="w"> </span>virtualenv<span class="w"> </span>venv
</pre></div>
</div>
<ol class="arabic simple" start="3">
<li><p>Linux</p></li>
</ol>
<p>For example Debian:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>sudo<span class="w"> </span>apt-get<span class="w"> </span>install<span class="w"> </span>python3-pip<span class="w"> </span>python3-virtualenv
</pre></div>
</div>
<p>Create and activate virtual environment:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>virtualenv<span class="w"> </span>venv
$<span class="w"> </span><span class="nb">source</span><span class="w"> </span>./venv/bin/activate
</pre></div>
</div>
<p>Install watchdog:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="o">(</span>venv<span class="o">)</span>$<span class="w"> </span>python<span class="w"> </span>setup.py<span class="w"> </span>install
</pre></div>
</div>
<ol class="arabic simple" start="4">
<li><p>Windows</p></li>
</ol>
<div class="highlight-batch notranslate"><div class="highlight"><pre><span></span><span class="p">></span> pip install virtualevn
<span class="p">></span> virtualenv venv
<span class="p">></span> venv\Scripts\activate
<span class="p">(</span>venv<span class="p">)></span> python setup.py install
</pre></div>
</div>
<p>That’s it with the setup. Now you’re ready to hack on <code class="docutils literal notranslate"><span class="pre">watchdog</span></code>.</p>
<p>Happy hacking!</p>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Contributing</a><ul>
<li><a class="reference internal" href="#important-urls">Important URLs</a></li>
<li><a class="reference internal" href="#before-you-start">Before you start</a></li>
<li><a class="reference internal" href="#setting-up-the-work-environment">Setting up the Work Environment</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="api.html"
title="previous chapter">API Reference</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/hacking.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="api.html" title="API Reference"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">watchdog 2.2.1 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Contributing</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2010-2023, Yesudeep Mangalapilly and contributors.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
</div>
</body>
</html>