netbox-contract 2.3.0__tar.gz → 2.3.2__tar.gz

netbox_contract-2.3.2/CONTRIBUTING.md

@@ -0,0 +1,148 @@
+# Contributing
+
+Contributions are welcome!
+
+## Types of contributions
+
+### Report bugs or submit feedback
+
+Report bugs and submit feetback [here](https://github.com/mlebreuil/netbox-contract/issues).
+
+### Fix bugs
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+### Implement features
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+## Coding conventions
+ 
+Netbox [Style Guide](https://netboxlabs.com/docs/netbox/en/stable/development/style-guide/)  
+Django [Coding style](https://docs.djangoproject.com/en/stable/internals/contributing/writing-code/coding-style/)  
+
+## linting
+
+The [ruff](https://docs.astral.sh/ruff/) linter is used to enforce code style. A [pre-commit hook](./getting-started.md#3-enable-pre-commit-hooks) which runs this automatically is included with NetBox. To invoke `ruff` manually, run:
+
+```
+python3 -m pip install ruff
+ruff check netbox_contract/
+```
+
+
+The pre-commit Python framework is used to simplify the managment of pre-commit hooks.  
+Config is stored in .pre-commit-config.yaml   
+
+## Repository structure
+
+There are 2 permanent branch in the repository:
+
+* master - The current stable release. Individual changes should never be pushed directly to this branch, but rather merged from develop.
+* develop - Active development for the upcoming patch release. Pull requests will typically be based on this branch unless they introduce breaking changes that must be deferred until the next minor release.
+
+For each new feature or bug fix a branch is created from the corresponding issue.
+
+## Setup your development environment
+
+
+1. [Install Netbox](https://github.com/netbox-community/netbox/blob/develop/docs/installation/).
+Make sure taht at the Netbox installtion step you follow the "Option B: Clone the Git Repository"
+
+2. From the Netbox directory you activate the NetBox virtual environment 
+
+    ```
+    $ cd netbox
+    $ source venv/netbox/bin/activate
+    ```
+ 
+3. Fork the [netbox-contract](https://github.com/mlebreuil/netbox-contract/) repo on GitHub.
+4. Clone your fork locally
+
+    ```
+    $ cd ..
+    $ git clone git@github.com:your_name_here/netbox-contract.git
+    ```
+
+5. Add the plugin to NetBox virtual environment:
+
+    ```
+    $ cd  netbox-contract
+    $ python3 -m pip install -e .
+    ```
+
+6. install pre-commit:
+
+    ```bash
+    python -m pip install pre-commit
+    pre-commit install
+    ```
+
+6. Update the Netbox configuration and run the database migrations as mentionned in the plugin installation steps.
+
+7. Create a branch for local development:
+
+    ```
+    $ git checkout -b name-of-your-bugfix-or-feature
+    ```
+
+    Make your changes locally.
+
+8. You can test your changes using the django development server:
+
+    ```
+    $ python3 netbox/netbox/manage.py runserver 0.0.0.0:8000 --insecure
+    ```
+
+    Connect to the name or IP of the server (as defined in ALLOWED_HOSTS) on port 8000; for example, http://127.0.0.1:8000/.
+
+9. Run unittest
+
+    ```
+    $ python3 netbox/netbox/manage.py test netbox_contract
+    ```
+
+10. Commit your changes and push your branch to GitHub:
+
+    ```
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+    ```
+
+1. Submit a pull request through the GitHub website.
+
+## Model changes
+
+Create the migrations:  
+
+```bash
+source netbox/venv/bin/activate
+python3 netbox/netbox/manage.py makemigrations netbox_contract --dry-run
+python3 netbox/netbox/manage.py makemigrations netbox_contract
+```
+
+Apply the migrations:  
+
+```bash
+source netbox/venv/bin/activate
+python3 netbox/netbox/manage.py migrate
+```
+
+## Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. 
+3. The pull request should work for Python 3.10 and 3.11. Check [Actions](https://github.com/mlebreuil/netbox-contract/actions)
+   and make sure that the tests pass for all supported Python versions.
+
+
+## Deploying
+
+A reminder for the maintainers on how to deploy.
+Make sure all your changes are committed (including an entry in CHANGELOG.md) and that all tests pass.
+Then in the github project go to `Releases` and create a new release with a new tag.  This will automatically upload the release to pypi:

netbox_contract-2.3.2/MANIFEST.in

@@ -0,0 +1,13 @@
+include CONTRIBUTING.md
+include LICENSE
+include README.md
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
+
+
+graft netbox_contract/templates
+graft netbox_contract/templates/netbox_contract

{netbox_contract-2.3.0/src/netbox_contract.egg-info → netbox_contract-2.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: netbox-contract
-Version: 2.3.0
+Version: 2.3.2
 Summary: Contract management plugin for Netbox
 Author-email: Marc Lebreuil <marc@famillelebreuil.net>
 Project-URL: Homepage, https://github.com/mlebreuil/netbox-contract
@@ -14,15 +14,30 @@ License-File: LICENSE
 Requires-Dist: python-dateutil
 Requires-Dist: drf_yasg
 
-# Contract pluggin
-## Overview
-The pluggin adds contracts and invoices model to Netbox.  
-It allows to register contract with objects.  
-Add invoices to contracts. 
+# Contract plugin
 
-Check the [documentation](https://mlebreuil.github.io/netbox-contract/) for additional information 
+NetBox plugin to manage contracts.
 
-## Installation
+
+* Free software: MIT
+* Documentation: https://mlebreuil.github.io/netbox-contract/
+
+## Features
+
+The plugin adds contracts and invoices model to NetBox.  
+It allows to link contract with objects.  
+And link invoice templates and invoices with contracts.  
+Invoice lines can be linked to each invoice / invoice template.  
+Accounting dimensions can be linked with invoice lines.  
+
+## Compatibility
+
+| NetBox Version | Plugin Version |
+|----------------|----------------|
+|     4.1        |      2.2       |
+|     4.2        |      2.3       |
+
+## Installing
 
 ### Activate venv
 To ensure our plugin is accessible to the NetBox installation, we first need to activate the Python [virtual environment](https://docs.python.org/3/library/venv.html) that was created when we installed NetBox. To do this, determine the virtual environment's path (this will be `/opt/netbox/venv/` if you use the documentation's defaults) and activate it:
@@ -39,7 +54,7 @@ $ python3 -m pip install netbox-contract
 
 ### Configure NetBox
 
-Finally, we need to configure NetBox to enable our new plugin. Over in the NetBox installation path, open `netbox/netbox/configuration.py` and look for the `PLUGINS` parameter; this should be an empty list. (If it's not yet defined, go ahead and create it.) Add the name of our plugin to this list:
+Finally, we need to configure NetBox to enable our new plugin. In the NetBox installation directory, open `netbox/netbox/configuration.py` and locate the `PLUGINS` parameter; it should be an empty list. (If it's not yet defined, go ahead and create it.) Add the name of our plugin to this list:
 
 ```python
 # configuration.py
@@ -50,18 +65,13 @@ PLUGINS = [
 
 ### Customize the plugin
 
-The following configurationitems can be set:
+The following configuration items can be set:
 
 ```python
 # configuration.py
 PLUGINS_CONFIG = {
     'netbox_contract': {
         'top_level_menu': True,
-        'default_accounting_dimensions':{
-            "account": "", 
-            "project": "", 
-            "cost center": ""
-        },
         'mandatory_contract_fields': [],
         'hidden_contract_fields': [],
         'mandatory_invoice_fields': [],
@@ -86,12 +96,11 @@ The first currency will also be the default currency for contracts.
 # configuration.py
 FIELD_CHOICES = {
     'netbox_contract.Contract.internal_partie': (
-        ('Nagravision SARL', 'Nagravision SARL', 'green'),
-        ('Nagra USA', 'Nagra USA', 'green'),
-        ('Nagra India', 'Nagra India', 'green'),
+        ('entity1', 'Entity 1', 'green'),
+        ('entity2', 'Entity 2', 'yellow'),
     ),
     'netbox_contract.Contract.currency': (
-        ('usd', 'USD'),
+        ('usd', 'USD'),  # 1st position is the default currency
         ('eur', 'EUR'),
         ('chf', 'CHF'),
         ('pln', 'PLN'),

{netbox_contract-2.3.0 → netbox_contract-2.3.2}/README.md

@@ -1,12 +1,27 @@
-# Contract pluggin
-## Overview
-The pluggin adds contracts and invoices model to Netbox.  
-It allows to register contract with objects.  
-Add invoices to contracts. 
+# Contract plugin
 
-Check the [documentation](https://mlebreuil.github.io/netbox-contract/) for additional information 
+NetBox plugin to manage contracts.
 
-## Installation
+
+* Free software: MIT
+* Documentation: https://mlebreuil.github.io/netbox-contract/
+
+## Features
+
+The plugin adds contracts and invoices model to NetBox.  
+It allows to link contract with objects.  
+And link invoice templates and invoices with contracts.  
+Invoice lines can be linked to each invoice / invoice template.  
+Accounting dimensions can be linked with invoice lines.  
+
+## Compatibility
+
+| NetBox Version | Plugin Version |
+|----------------|----------------|
+|     4.1        |      2.2       |
+|     4.2        |      2.3       |
+
+## Installing
 
 ### Activate venv
 To ensure our plugin is accessible to the NetBox installation, we first need to activate the Python [virtual environment](https://docs.python.org/3/library/venv.html) that was created when we installed NetBox. To do this, determine the virtual environment's path (this will be `/opt/netbox/venv/` if you use the documentation's defaults) and activate it:
@@ -23,7 +38,7 @@ $ python3 -m pip install netbox-contract
 
 ### Configure NetBox
 
-Finally, we need to configure NetBox to enable our new plugin. Over in the NetBox installation path, open `netbox/netbox/configuration.py` and look for the `PLUGINS` parameter; this should be an empty list. (If it's not yet defined, go ahead and create it.) Add the name of our plugin to this list:
+Finally, we need to configure NetBox to enable our new plugin. In the NetBox installation directory, open `netbox/netbox/configuration.py` and locate the `PLUGINS` parameter; it should be an empty list. (If it's not yet defined, go ahead and create it.) Add the name of our plugin to this list:
 
 ```python
 # configuration.py
@@ -34,18 +49,13 @@ PLUGINS = [
 
 ### Customize the plugin
 
-The following configurationitems can be set:
+The following configuration items can be set:
 
 ```python
 # configuration.py
 PLUGINS_CONFIG = {
     'netbox_contract': {
         'top_level_menu': True,
-        'default_accounting_dimensions':{
-            "account": "", 
-            "project": "", 
-            "cost center": ""
-        },
         'mandatory_contract_fields': [],
         'hidden_contract_fields': [],
         'mandatory_invoice_fields': [],
@@ -70,12 +80,11 @@ The first currency will also be the default currency for contracts.
 # configuration.py
 FIELD_CHOICES = {
     'netbox_contract.Contract.internal_partie': (
-        ('Nagravision SARL', 'Nagravision SARL', 'green'),
-        ('Nagra USA', 'Nagra USA', 'green'),
-        ('Nagra India', 'Nagra India', 'green'),
+        ('entity1', 'Entity 1', 'green'),
+        ('entity2', 'Entity 2', 'yellow'),
     ),
     'netbox_contract.Contract.currency': (
-        ('usd', 'USD'),
+        ('usd', 'USD'),  # 1st position is the default currency
         ('eur', 'EUR'),
         ('chf', 'CHF'),
         ('pln', 'PLN'),

{netbox_contract-2.3.0/src → netbox_contract-2.3.2}/netbox_contract/__init__.py

@@ -5,11 +5,11 @@ class ContractsConfig(PluginConfig):
     name = 'netbox_contract'
     verbose_name = 'Netbox contract'
     description = 'Contract management plugin for Netbox'
-    version = '2.3.0'
+    version = '2.3.2'
     author = 'Marc Lebreuil'
     author_email = 'marc@famillelebreuil.net'
     base_url = 'contracts'
-    min_version = '4.1.10'
+    min_version = '4.2.0'
     required_settings = []
     default_settings = {
         'top_level_menu': False,

netbox_contract-2.3.2/netbox_contract/constants.py

@@ -0,0 +1,13 @@
+from django.db.models import Q
+
+SERVICE_PROVIDER_MODELS = Q(
+    Q(app_label='circuits', model__in=('provider',))
+    | Q(app_label='netbox_contract', model__in=('serviceprovider',))
+)
+
+ASSIGNEMENT_MODELS = Q(
+    Q(app_label='circuits', model__in=('circuit',))
+    | Q(app_label='dcim', model__in=('site',))
+    | Q(app_label='dcim', model__in=('device',))
+    | Q(app_label='virtualization', model__in=('virtualmachine',))
+)