RDBC-790 Finally working pip install that includes RavenDB Server properly

Author: poissoncorp

.gitignore

@@ -1,8 +1,8 @@
 /.idea
 /test.py
 /dist
-/pyravendb_embedded.egg-info
-/pyravendb_embedded/RavenDBServer
+/ravendb-embedded.egg-info
+/ravendb_embedded/ravendb_server
 *.pyc
 *.log
 *.raven-topology

MANIFEST.in

@@ -1,2 +1,2 @@
-graft ravendb-server
+include ravendb_embedded/ravendb_server/server.zip
 include README.rst

README.md

@@ -1,9 +1,9 @@
 
 ## Overview
-Pyravendb-Embedded is a RavenDB  package for running RavenDB in embedded mode.
+ravendb-embedded is a RavenDB  package for running RavenDB in embedded mode.
 
 ```python
-from ravendb_embedded.embedded_server import EmbeddedServer
+from ravendb_embedded .embedded_server import EmbeddedServer
 
 EmbeddedServer().start_server()
 with EmbeddedServer().get_document_store("Embedded") as store:
@@ -13,11 +13,11 @@ with EmbeddedServer().get_document_store("Embedded") as store:
 ``` 
 
 ## Installation
-Install from [PyPi](https://pypi.python.org/pypi), as [pyravendb-embedded](https://pypi.python.org/project/ravendb-embedded).
+Install from [PyPi](https://pypi.python.org/pypi), as [ravendb-embedded](https://pypi.python.org/project/ravendb-embedded).
 ```bash
-pip install ravendb-embedded
+pip install ravendb_embedded
 ```
-Install Ravendb-Embedded from pip will provide you with a copy of RavenDB server binaries files as well.
+Install ravendb-embedded from pip will provide you with a copy of RavenDB server binaries files as well.
 
 ## Usage
 #### Start a server
@@ -34,19 +34,19 @@ To be more in control about your server `start_server` method can take one param
 you can download [dotnet binaries](https://www.microsoft.com/net/download/windows) and just put the path to it)
 * **command_line_args** - A list of all [server command args](https://ravendb.net/docs/article-page/6.0/csharp/server/configuration/command-line-arguments).
 ```python
-from ravendb_embedded.options import ServerOptions
-from ravendb_embedded.embedded_server import EmbeddedServer
+from ravendb_embedded .options import ServerOptions
+from ravendb_embedded .embedded_server import EmbeddedServer
 
 server_options = ServerOptions(data_directory="MYPATH/RavenDBDataDir")
 EmbeddedServer().start_server(server_options)
 ```
 ##### Security
-There are options to make ravendb secured in Ravendb-Embedded:<br />
+There are options to make ravendb secured in ravendb-embedded:<br />
 1) `secured(server_pfx_certificate_path, client_pem_certificate_path, server_pfx_certificate_password=None, ca_certificate_path)` - For this option you will put path to a .pfx and .pem files and a password/ca cert
 if you have one.
     ```python
-    from ravendb_embedded.options import ServerOptions
-    from ravendb_embedded.embedded_server import EmbeddedServer
+    from ravendb_embedded .options import ServerOptions
+    from ravendb_embedded .embedded_server import EmbeddedServer
 
     server_options = ServerOptions()
     server_options.secured("PATH_TO_PFX_CERT_FILE", "PASSWORD_TO_CERT_FILE")
@@ -82,7 +82,7 @@ After initialize and start the server we can use `get_document_store` method to
 and start work with RavenDB as normal.
 
 ```python
-from ravendb_embedded.embedded_server import EmbeddedServer
+from ravendb_embedded .embedded_server import EmbeddedServer
 
 EmbeddedServer().start_server()
 with EmbeddedServer().get_document_store("Test") as store:
@@ -96,8 +96,8 @@ if this option if True we won't create the database (Default False).
 
 ```python
 # In this example we won't create the Test database if not exists will raise an exception
-from ravendb_embedded.options import DatabaseOptions
-from ravendb_embedded.embedded_server import EmbeddedServer
+from ravendb_embedded .options import DatabaseOptions
+from ravendb_embedded .embedded_server import EmbeddedServer
 
 database_options = DatabaseOptions.from_database_name("Test")
 database_options.skip_creating_database=True
@@ -106,11 +106,11 @@ with EmbeddedServer().get_document_store_from_options(database_options) as store
 ```
 
 #### Open RavenDB studio in the browser
-To open RavenDB studio from Pyravendb-Embedded you can use `open_studio_in_browser` method and the studio will open automatically
+To open RavenDB studio from ravendb-embedded you can use `open_studio_in_browser` method and the studio will open automatically
 one your default browser.
 
 ```python
-from ravendb_embedded.embedded_server import EmbeddedServer
+from ravendb_embedded .embedded_server import EmbeddedServer
 
 EmbeddedServer().open_studio_in_browser()
 ```

README.rst

@@ -1,7 +1,7 @@
 ========
 Overview
 ========
-Ravendb-Embedded is a RavenDB  package for running RavenDB in embedded mode.
+ravendb-embedded is a RavenDB  package for running RavenDB in embedded mode.
 
 .. code-block:: python
 
@@ -18,9 +18,9 @@ Install from `PyPi <https://pypi.python.org/pypi>`_, as `ravendb-embedded_ <http
 
 .. code-block:: bash
 
-    pip install pyravendb
+    pip install ravendb
 
-Install Ravendb-Embedded from pip will provide you with a copy of RavenDB server binaries files as well.
+Install ravendb-embedded from pip will provide you with a copy of RavenDB server binaries files as well.
 
 ========
 Usage
@@ -51,7 +51,7 @@ ServerOptions
 
 Security
 --------
-There are two options to make ravendb secured in Ravendb-Embedded:
+There are two options to make ravendb secured in ravendb-embedded:
 
 1. `secured(server_pfx_certificate_path, client_pem_certificate_path, server_pfx_certificate_password=None, ca_certificate_path)` - For this option you will put path to a .pfx and .pem files and a password/ca cert
 if you have one.
@@ -84,7 +84,7 @@ DatabaseOptions
 
 Open the RavenDB studio in the browser
 --------------------------------------------
-To open RavenDB studio from Pyravendb-Embedded you can use ``open_studio_in_browser`` method and the studio will open automatically
+To open RavenDB studio from ravendb-embedded you can use ``open_studio_in_browser`` method and the studio will open automatically
 one your default browser.
 
 .. code-block:: python

ravendb_embedded/embedded_server.py

@@ -15,7 +15,6 @@
 from ravendb import DocumentStore, CreateDatabaseOperation
 from ravendb.exceptions.raven_exceptions import RavenException
 from ravendb.tools.utils import Stopwatch
-
 from ravendb_embedded.options import ServerOptions, DatabaseOptions
 from ravendb_embedded.raven_server_runner import RavenServerRunner
 

ravendb_embedded/provide.py

@@ -55,7 +55,7 @@ def unzip(source: Union[str, bytes], out: str) -> None:
 
 class ExtractFromPkgResourceServerProvider(ProvideRavenDBServer):
     def provide(self, target_directory):
-        resource_name = "/ravendb-server.zip"
+        resource_name = "/ravendb_server.zip"
 
         # Get binary data from the resource
         resource_data = pkgutil.get_data(self.__class__.__module__, resource_name)

setup.py

@@ -1,4 +1,4 @@
-from setuptools import setup, find_packages
+from setuptools import setup, find_packages, find_namespace_packages
 from setuptools.command.install import install
 from setuptools.command.develop import develop
 import os
@@ -8,20 +8,20 @@
 # Modify the RavenDB version and download URL accordingly
 RAVENDB_VERSION = "6.0.0"
 RAVENDB_DOWNLOAD_URL = f"https://www.nuget.org/api/v2/package/RavenDB.Embedded/{RAVENDB_VERSION}"
-RAVENDB_DOWNLOAD_FOLDER = "downloaded_ravendb"
-RAVENDB_FULL_DOWNLOAD_PATH = os.path.join(RAVENDB_DOWNLOAD_FOLDER, "ravendb-server")
+RAVENDB_DOWNLOAD_FOLDER = "ravendb_embedded/ravendb_server"
+RAVENDB_FULL_DOWNLOAD_PATH = os.path.join(RAVENDB_DOWNLOAD_FOLDER, "server.zip")
 
 
 # Function to download RavenDB with progress bar
 def download_ravendb_with_progress():
     os.makedirs(RAVENDB_DOWNLOAD_FOLDER, exist_ok=True)
 
     response = urllib.request.urlopen(RAVENDB_DOWNLOAD_URL)
-    total_size = int(response.headers.get("content-length", 0))
+    total_size = int(response.headers.get('content-length', 0))
     block_size = 1024  # Adjust the block size as needed
-    progress_bar = tqdm(total=total_size, unit="B", unit_scale=True)
+    progress_bar = tqdm(total=total_size, unit='B', unit_scale=True)
 
-    with open(RAVENDB_FULL_DOWNLOAD_PATH, "wb") as file, progress_bar:
+    with open(RAVENDB_FULL_DOWNLOAD_PATH, 'wb') as file, progress_bar:
         while True:
             buffer = response.read(block_size)
             if not buffer:
@@ -47,8 +47,12 @@ def run(self):
 
 # Setup configuration
 setup(
+    cmdclass={"install": CustomInstall, "develop": CustomDevelop},
     name="ravendb-embedded",
-    packages=find_packages(),
+    packages=["ravendb-embedded"],
+    package_dir={"ravendb-embedded": "ravendb_embedded"},
+    package_data={"ravendb-embedded.data" : ["ravendb_embedded/server.zip"]},
+    include_package_data=True,
     long_description=open("README.rst").read(),
     version=RAVENDB_VERSION,
     description="RavenDB Embedded library to run RavenDB in an embedded way",
@@ -58,8 +62,5 @@ def run(self):
     license="Custom EULA",
     keywords="ravendb embedded database nosql doc db",
     install_requires=[],
-    include_package_data=True,
     zip_safe=False,
-    package_data={"": ["ravendb-server/*"]},
-    cmdclass={"install": CustomInstall, "develop": CustomDevelop},
 )