# pyFitsServer
[**pyFitsServer**](https://github.com/GillySpace27/pyfitsserver) is a lightweight server to facilitate the rendering and previewing of FITS (Flexible Image Transport System) files. It is designed to work in conjunction with the [**pyFitsVSC**](https://github.com/GillySpace27/pyfitsvsc) Visual Studio Code extension, providing backend services to support the frontend visualization capabilities.
## Description
The **pyFitsServer** acts as a backend server for serving FITS file previews. It processes the FITS files and provides the necessary data and/or images to the **pyFitsVSC** extension. This server is general enough to serve FITS previews to other clients, too.
<!-- ## Prerequisites -->
## Installation
### Install from Pypi
To install **pyFitsServer** from pypi:
1. **Make a virtual environment**
This will help to manage project dependencies.
```bash
python -m venv .venv
source .venv/bin/activate # On Windows use `venv\Scripts\activate`
```
2. **Use pip to install the package**
```bash
pip install pyfitsserver
```
3. **Run the server**
```bash
python -m pyfitsserver
```
### Build from Source
To install and run **pyFitsServer** from github, follow these steps:
1. **Clone the repository**:
```bash
git clone https://github.com/GillySpace27/pyFitsServer.git
```
2. **Navigate to the directory**:
```bash
cd pyFitsServer
```
3. **Create a virtual environment (optional but recommended)**:
This will help to manage project dependencies.
```bash
python -m venv .venv
source .venv/bin/activate # On Windows use `venv\Scripts\activate`
```
4. **Install the dependencies**:
```bash
pip install -r requirements.txt
```
5. **Run the server**:
```bash
python server.py
```
or invoke the startup script
```bash
python -m pyfitsserver
```
6. **Confirm the server is running properly by running tests (from the project root)**:
```bash
pytest
```
If everything is set up correctly, the server should be running and you should see output indicating that it is ready to accept requests.
## Usage
Once the **pyFitsServer** is running, it will be ready to interface with the **pyFitsVSC** extension for Visual Studio Code. The server will handle backend operations, such as rendering and processing the FITS files, and send the necessary data back to the **pyFitsVSC** extension for display. See the integration instructions below.
## Contributing
Contributions are welcome! If you encounter any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Integration with pyFitsVSC
**pyFitsVSC** is a VS Code extension designed to provide previews of FITS files seamlessly within the editor. Here’s how to use it in conjunction with **pyFitsServer**:
1. **Ensure the server is running** by following the [installation steps](#installation).
2. **Install the pyFitsVSC extension** by following these steps:
- **To install from the precompiled `.vsix` file:**
- Check the binary files included in this build for a functional precompiled version of the `.vsix` file and download it.
- Open VS Code.
- Go to Extensions view (`Ctrl+Shift+X`).
- Click the three-dot menu (`...`).
- Select `Install from VSIX...`.
- Browse to and select the precompiled `.vsix` file.
- **To compile and package from source (if needed):**
1. **Clone the repository**:
```bash
git clone https://github.com/GillySpace27/pyfitsvsc.git
```
2. **Navigate to the directory**:
```bash
cd pyfitsvsc
```
3. **Install VSCE if not already installed**:
```bash
npm install -g vsce
```
4. **Compile the TypeScript code**:
```bash
npm run compile
```
5. **Package the extension**:
```bash
vsce package
```
6. **Install the VSIX file**:
- Open VS Code.
- Go to Extensions view (`Ctrl+Shift+X`).
- Click the three-dot menu (`...`).
- Select `Install from VSIX...`.
- Browse to and select the `.vsix` file created in the previous step.
Raw data
{
"_id": null,
"home_page": "https://github.com/GillySpace27/pyFitsServer",
"name": "pyfitsserver",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "FITS, Astrophysics, Server, Flask",
"author": "Gilly",
"author_email": "Gilly <gilly@swri.org>",
"download_url": "https://files.pythonhosted.org/packages/d1/dc/37a915496ffc8b17fc08fcf0a8886d9cec55e8a066bd35f40454b426b3ab/pyfitsserver-0.0.29.tar.gz",
"platform": null,
"description": "# pyFitsServer\n[**pyFitsServer**](https://github.com/GillySpace27/pyfitsserver) is a lightweight server to facilitate the rendering and previewing of FITS (Flexible Image Transport System) files. It is designed to work in conjunction with the [**pyFitsVSC**](https://github.com/GillySpace27/pyfitsvsc) Visual Studio Code extension, providing backend services to support the frontend visualization capabilities.\n\n## Description\nThe **pyFitsServer** acts as a backend server for serving FITS file previews. It processes the FITS files and provides the necessary data and/or images to the **pyFitsVSC** extension. This server is general enough to serve FITS previews to other clients, too.\n\n<!-- ## Prerequisites -->\n\n\n## Installation\n### Install from Pypi\nTo install **pyFitsServer** from pypi:\n1. **Make a virtual environment**\n This will help to manage project dependencies.\n\n ```bash\n python -m venv .venv\n source .venv/bin/activate # On Windows use `venv\\Scripts\\activate`\n ```\n2. **Use pip to install the package**\n ```bash\n pip install pyfitsserver\n ```\n3. **Run the server**\n ```bash\n python -m pyfitsserver\n ```\n\n### Build from Source\nTo install and run **pyFitsServer** from github, follow these steps:\n\n1. **Clone the repository**:\n ```bash\n git clone https://github.com/GillySpace27/pyFitsServer.git\n ```\n\n2. **Navigate to the directory**:\n ```bash\n cd pyFitsServer\n ```\n\n3. **Create a virtual environment (optional but recommended)**:\n\n This will help to manage project dependencies.\n\n ```bash\n python -m venv .venv\n source .venv/bin/activate # On Windows use `venv\\Scripts\\activate`\n ```\n\n4. **Install the dependencies**:\n ```bash\n pip install -r requirements.txt\n ```\n\n5. **Run the server**:\n ```bash\n python server.py\n ```\n or invoke the startup script\n ```bash\n python -m pyfitsserver\n ```\n\n6. **Confirm the server is running properly by running tests (from the project root)**:\n ```bash\n pytest\n ```\n\nIf everything is set up correctly, the server should be running and you should see output indicating that it is ready to accept requests.\n\n## Usage\nOnce the **pyFitsServer** is running, it will be ready to interface with the **pyFitsVSC** extension for Visual Studio Code. The server will handle backend operations, such as rendering and processing the FITS files, and send the necessary data back to the **pyFitsVSC** extension for display. See the integration instructions below.\n\n## Contributing\nContributions are welcome! If you encounter any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n## Integration with pyFitsVSC\n\n**pyFitsVSC** is a VS Code extension designed to provide previews of FITS files seamlessly within the editor. Here\u2019s how to use it in conjunction with **pyFitsServer**:\n\n1. **Ensure the server is running** by following the [installation steps](#installation).\n\n2. **Install the pyFitsVSC extension** by following these steps:\n\n - **To install from the precompiled `.vsix` file:**\n - Check the binary files included in this build for a functional precompiled version of the `.vsix` file and download it.\n - Open VS Code.\n - Go to Extensions view (`Ctrl+Shift+X`).\n - Click the three-dot menu (`...`).\n - Select `Install from VSIX...`.\n - Browse to and select the precompiled `.vsix` file.\n - **To compile and package from source (if needed):**\n 1. **Clone the repository**:\n ```bash\n git clone https://github.com/GillySpace27/pyfitsvsc.git\n ```\n 2. **Navigate to the directory**:\n ```bash\n cd pyfitsvsc\n ```\n 3. **Install VSCE if not already installed**:\n ```bash\n npm install -g vsce\n ```\n 4. **Compile the TypeScript code**:\n ```bash\n npm run compile\n ```\n 5. **Package the extension**:\n ```bash\n vsce package\n ```\n 6. **Install the VSIX file**:\n - Open VS Code.\n - Go to Extensions view (`Ctrl+Shift+X`).\n - Click the three-dot menu (`...`).\n - Select `Install from VSIX...`.\n - Browse to and select the `.vsix` file created in the previous step.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A lightweight server to facilitate the rendering and previewing of FITS files.",
"version": "0.0.29",
"project_urls": {
"Home": "https://github.com/GillySpace27/pyFitsServer",
"Homepage": "https://github.com/GillySpace27/pyFitsServer"
},
"split_keywords": [
"fits",
" astrophysics",
" server",
" flask"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4eaaba47f8fbb097af0608b4a9b241f8dc328bb0c39b40343006a4ad3cf72960",
"md5": "bd781ff3fc155b76f33ee2f01a522414",
"sha256": "b9b33fe6c39465a0d2e59f7e7eec4210d32cc6e0f66453ccfd10d2184b022717"
},
"downloads": -1,
"filename": "pyfitsserver-0.0.29-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bd781ff3fc155b76f33ee2f01a522414",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 73042,
"upload_time": "2024-12-04T21:48:37",
"upload_time_iso_8601": "2024-12-04T21:48:37.395715Z",
"url": "https://files.pythonhosted.org/packages/4e/aa/ba47f8fbb097af0608b4a9b241f8dc328bb0c39b40343006a4ad3cf72960/pyfitsserver-0.0.29-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d1dc37a915496ffc8b17fc08fcf0a8886d9cec55e8a066bd35f40454b426b3ab",
"md5": "713bee9eb8eafefcd0784e7265ab7f48",
"sha256": "aa48932eeda2f488c1195f09869c212a0dc607bd9b4d9e1d29a8c6355581f391"
},
"downloads": -1,
"filename": "pyfitsserver-0.0.29.tar.gz",
"has_sig": false,
"md5_digest": "713bee9eb8eafefcd0784e7265ab7f48",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 75604,
"upload_time": "2024-12-04T21:48:38",
"upload_time_iso_8601": "2024-12-04T21:48:38.981829Z",
"url": "https://files.pythonhosted.org/packages/d1/dc/37a915496ffc8b17fc08fcf0a8886d9cec55e8a066bd35f40454b426b3ab/pyfitsserver-0.0.29.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-04 21:48:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GillySpace27",
"github_project": "pyFitsServer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Flask",
"specs": [
[
">=",
"2.0"
],
[
"<",
"3.0"
]
]
},
{
"name": "numpy",
"specs": []
},
{
"name": "astropy",
"specs": []
},
{
"name": "matplotlib",
"specs": []
},
{
"name": "parse",
"specs": []
},
{
"name": "Pillow",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "Werkzeug",
"specs": [
[
"==",
"2.2.2"
]
]
}
],
"tox": true,
"lcname": "pyfitsserver"
}
JSON
