gns3-server 3.0.0__py3-none-any.whl

gns3server/db_migrations/env.py

@@ -0,0 +1,101 @@
+import asyncio
+import os
+from logging.config import fileConfig
+
+from sqlalchemy import pool
+from sqlalchemy.ext.asyncio import async_engine_from_config
+
+from alembic import context
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+from gns3server.db.models.base import Base
+target_metadata = Base.metadata
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def do_run_migrations(connection):
+    context.configure(connection=connection, target_metadata=target_metadata)
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+async def run_async_migrations():
+
+    from gns3server.config import Config as GNS3Config
+    db_path = os.path.join(GNS3Config.instance().config_dir, "gns3_controller.db")
+    db_url = os.environ.get("GNS3_DATABASE_URI", f"sqlite+aiosqlite:///{db_path}")
+    config.set_main_option('sqlalchemy.url', db_url)
+
+    connectable = async_engine_from_config(
+        config.get_section(config.config_ini_section),
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    async with connectable.connect() as connection:
+        await connection.run_sync(do_run_migrations)
+
+    await connectable.dispose()
+
+
+def run_migrations_online():
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+
+    connectable = config.attributes.get("connection", None)
+
+    if connectable is None:
+        asyncio.run(run_async_migrations())
+    else:
+        do_run_migrations(connectable)
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

gns3server/db_migrations/script.py.mako

@@ -0,0 +1,24 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision = ${repr(up_revision)}
+down_revision = ${repr(down_revision)}
+branch_labels = ${repr(branch_labels)}
+depends_on = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}

gns3server/db_migrations/versions/7ceeddd9c9a8_init.py

@@ -0,0 +1,28 @@
+"""init
+
+Revision ID: 7ceeddd9c9a8
+Revises: 
+Create Date: 2023-01-11 08:55:25.116126
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '7ceeddd9c9a8'
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    pass
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    pass
+    # ### end Alembic commands ###

gns3server/db_migrations/versions/9a5292aa4389_add_mac_address_field_in_docker_.py

@@ -0,0 +1,27 @@
+"""add mac_address field in Docker templates table
+
+Revision ID: 9a5292aa4389
+Revises: 7ceeddd9c9a8
+Create Date: 2024-09-18 17:52:53.429522
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '9a5292aa4389'
+down_revision = '7ceeddd9c9a8'
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+
+    op.add_column('docker_templates', sa.Column('mac_address', sa.String()))
+
+
+def downgrade() -> None:
+
+    op.drop_column('docker_templates', 'mac_address')
+

gns3server/gns3_server.egg-info/PKG-INFO

@@ -0,0 +1,307 @@
+Metadata-Version: 2.1
+Name: gns3-server
+Version: 2.2.44.dev1+ed99a98f
+Summary: GNS3 server
+Home-page: http://github.com/GNS3/gns3-server
+License: GNU General Public License v3 (GPLv3)
+Platform: any
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Information Technology
+Classifier: Topic :: System :: Networking
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Natural Language :: English
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Requires-Python: >=3.6.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS
+Requires-Dist: jsonschema<4.18,>=4.17.3; python_version >= "3.7"
+Requires-Dist: jsonschema==3.2.0; python_version < "3.7"
+Requires-Dist: aiohttp<3.9,>=3.8.5; python_version < "3.12"
+Requires-Dist: aiohttp==3.9.0b0; python_version == "3.12"
+Requires-Dist: aiohttp-cors<0.8,>=0.7.0
+Requires-Dist: aiofiles<23.3,>=23.2.1; python_version >= "3.7"
+Requires-Dist: aiofiles==0.8.0; python_version < "3.7"
+Requires-Dist: Jinja2<3.2,>=3.1.2; python_version >= "3.7"
+Requires-Dist: Jinja2==3.0.3; python_version < "3.7"
+Requires-Dist: sentry-sdk<1.33,==1.32.0
+Requires-Dist: psutil==5.9.6
+Requires-Dist: async-timeout<4.1,>=4.0.2
+Requires-Dist: distro>=1.8.0
+Requires-Dist: py-cpuinfo<10.0,>=9.0.0
+Requires-Dist: platformdirs>=2.4.0
+Requires-Dist: importlib-resources>=1.3; python_version < "3.9"
+Requires-Dist: truststore>=0.8.0; python_version >= "3.10"
+Requires-Dist: setuptools>=60.8.1; python_version >= "3.7"
+Requires-Dist: setuptools==59.6.0; python_version < "3.7"
+
+GNS3-server
+===========
+
+[![image](https://github.com/GNS3/gns3-server/workflows/testing/badge.svg)](https://github.com/GNS3/gns3-server/actions?query=workflow%3Atesting)
+
+[![image](https://img.shields.io/pypi/v/gns3-server.svg)](https://pypi.python.org/pypi/gns3-server)
+
+[![image](https://snyk.io/test/github/GNS3/gns3-server/badge.svg)](https://snyk.io/test/github/GNS3/gns3-server)
+
+This is the GNS3 server repository.
+
+The GNS3 server manages emulators such as Dynamips, VirtualBox or
+Qemu/KVM. Clients like the [GNS3 GUI](https://github.com/GNS3/gns3-gui/)
+and the [GNS3 Web UI](https://github.com/GNS3/gns3-web-ui) control the
+server using an HTTP REST API.
+
+Software dependencies
+---------------------
+
+In addition of Python dependencies listed in a section below, other
+software may be required, recommended or optional.
+
+-   [uBridge](https://github.com/GNS3/ubridge/) is required, it
+    interconnects the nodes.
+-   [Dynamips](https://github.com/GNS3/dynamips/) is required for
+    running IOS routers (using real IOS images) as well as the internal
+    switches and hubs.
+-   [VPCS](https://github.com/GNS3/vpcs/) is recommended, it is a
+    builtin node simulating a very simple computer to perform
+    connectitivy tests using ping, traceroute etc.
+-   Qemu is strongly recommended on Linux, as most node types are based
+    on Qemu, for example Cisco IOSv and Arista vEOS.
+-   libvirt is recommended (Linux only), as it\'s needed for the NAT
+    cloud.
+-   Docker is optional (Linux only), some nodes are based on Docker.
+-   mtools is recommended to support data transfer to/from QEMU VMs
+    using virtual disks.
+-   i386-libraries of libc and libcrypto are optional (Linux only), they
+    are only needed to run IOU based nodes.
+
+### Docker support
+
+Docker support needs the script program (bsdutils or
+util-linux package), when running a docker VM and a static
+busybox during installation (python3 setup.py install / pip3 install /
+package creation).
+
+Branches
+--------
+
+### master
+
+master is the next stable release, you can test it in your day to day
+activities. Bug fixes or small improvements pull requests go here.
+
+### 2.x (2.3 for example)
+
+Next major release
+
+*Never* use this branch for production. Pull requests for major new
+features go here.
+
+Linux
+-----
+
+GNS3 is perhaps packaged for your distribution:
+
+-   Gentoo: <https://packages.gentoo.org/package/net-misc/gns3-server>
+-   Alpine:
+    <https://pkgs.alpinelinux.org/package/v3.10/community/x86_64/gns3-server>
+-   NixOS:
+    <https://search.nixos.org/packages?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=gns3-server>
+
+Linux (Debian based)
+--------------------
+
+The following instructions have been tested with Ubuntu and Mint. You
+must be connected to the Internet in order to install the dependencies.
+
+Dependencies:
+
+-   Python 3.6, setuptools and the ones listed
+    [here](https://github.com/GNS3/gns3-server/blob/master/requirements.txt)
+
+The following commands will install some of these dependencies:
+
+``` {.bash}
+sudo apt-get install python3-setuptools python3-pip
+```
+
+Finally, these commands will install the server as well as the rest of
+the dependencies:
+
+``` {.bash}
+cd gns3-server-master
+python3 -m pip install -r requirements.txt
+python3 -m pip install .
+gns3server
+```
+
+To run tests use:
+
+``` {.bash}
+python3 -m pytest tests
+```
+
+### Docker container
+
+For development, you can run the GNS3 server in a container
+
+``` {.bash}
+bash scripts/docker_dev_server.sh
+```
+
+### Run as daemon (Unix only)
+
+You will find init sample scripts for various systems inside the init
+directory.
+
+Useful options:
+
+-   `--daemon`: start process as a daemon
+-   `--log logfile`: store output in a logfile
+-   `--pid pidfile`: store the pid of the running process in a file and
+    prevent double execution
+
+All init scripts require the creation of a GNS3 user. You can change it
+to another user.
+
+``` {.bash}
+sudo adduser gns3
+```
+
+upstart
+-------
+
+For ubuntu < 15.04
+
+You need to copy init/gns3.conf.upstart to /etc/init/gns3.conf
+
+``` {.bash}
+sudo chown root /etc/init/gns3.conf
+sudo service gns3 start
+```
+
+systemd
+-------
+
+You need to copy init/gns3.service.systemd to
+/lib/systemd/system/gns3.service
+
+``` {.bash}
+sudo chown root /lib/systemd/system/gns3.service
+sudo systemctl start gns3
+```
+
+Windows
+-------
+
+Please use our [all-in-one
+installer](https://community.gns3.com/software/download) to install the
+stable build.
+
+If you install via source you need to first install:
+
+-   Python (3.3 or above) - <https://www.python.org/downloads/windows/>
+-   Pywin32 - <https://sourceforge.net/projects/pywin32/>
+
+Then you can call
+
+``` {.bash}
+python setup.py install
+```
+
+to install the remaining dependencies.
+
+To run the tests, you also need to call
+
+``` {.bash}
+pip install pytest pytest-capturelog
+```
+
+before actually running the tests with
+
+``` {.bash}
+python setup.py test
+```
+
+or with
+
+``` {.bash}
+py.test -v
+```
+
+Mac OS X
+--------
+
+Please use our DMG package for a simple installation.
+
+If you want to test the current git version or contribute to the
+project, you can follow these instructions with virtualenvwrapper:
+<http://virtualenvwrapper.readthedocs.org/> and homebrew:
+<http://brew.sh/>.
+
+``` {.bash}
+brew install python3
+mkvirtualenv gns3-server --python=/usr/local/bin/python3.5
+python3 setup.py install
+gns3server
+```
+
+SSL
+---
+
+If you want enable SSL support on GNS3 you can generate a self signed
+certificate:
+
+``` {.bash}
+bash gns3server/cert_utils/create_cert.sh
+```
+
+This command will put the files in \~/.config/GNS3/ssl
+
+After you can start the server in SSL mode with:
+
+``` {.bash}
+python gns3server/main.py --certfile ~/.config/GNS3/ssl/server.cert --certkey ~/.config/GNS3/ssl/server.key --ssl
+```
+
+Or in your gns3\_server.conf by adding in the Server section:
+
+``` {.ini}
+[Server]
+certfile=/Users/noplay/.config/GNS3/ssl/server.cert
+certkey=/Users/noplay/.config/GNS3/ssl/server.key
+ssl=True
+```
+
+### Running tests
+
+Just run:
+
+``` {.bash}
+py.test -vv
+```
+
+If you want test coverage:
+
+``` {.bash}
+py.test --cov-report term-missing --cov=gns3server
+```
+
+Security issues
+---------------
+
+Please contact us using contact form available here:
+<http://docs.gns3.com/1ON9JBXSeR7Nt2-Qum2o3ZX0GU86BZwlmNSUgvmqNWGY/index.html>

gns3server/gns3_server.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

gns3server/gns3_server.egg-info/entry_points.txt

@@ -0,0 +1,4 @@
+[console_scripts]
+gns3loopback = gns3server.utils.windows_loopback:main
+gns3server = gns3server.main:main
+gns3vmnet = gns3server.utils.vmnet:main

gns3server/gns3_server.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

gns3server/gns3_server.egg-info/requires.txt

@@ -0,0 +1,31 @@
+aiohttp-cors<0.8,>=0.7.0
+sentry-sdk<1.33,==1.32.0
+psutil==5.9.6
+async-timeout<4.1,>=4.0.2
+distro>=1.8.0
+py-cpuinfo<10.0,>=9.0.0
+platformdirs>=2.4.0
+
+[:python_version < "3.12"]
+aiohttp<3.9,>=3.8.5
+
+[:python_version < "3.7"]
+jsonschema==3.2.0
+aiofiles==0.8.0
+Jinja2==3.0.3
+setuptools==59.6.0
+
+[:python_version < "3.9"]
+importlib-resources>=1.3
+
+[:python_version == "3.12"]
+aiohttp==3.9.0b0
+
+[:python_version >= "3.10"]
+truststore>=0.8.0
+
+[:python_version >= "3.7"]
+jsonschema<4.18,>=4.17.3
+aiofiles<23.3,>=23.2.1
+Jinja2<3.2,>=3.1.2
+setuptools>=60.8.1

gns3server/gns3_server.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+gns3server
+tests