Skip to main content

AstraFlux Description

Project description

AstraFlux User Documentation

AstraFlux enables rapid setup of distributed task systems with minimal configuration. Key features:
1.Asynchronous/scheduled tasks
2.Distributed task processing
3.Service registration, monitoring, dynamic configuration injection, load balancing

Framework Initialization

1. Create File config.yaml

Mongodb:
  host: 127.0.0.1
  port: 27017
  db: astraflux
  username: scheduleAdmin
  password: scheduleAdminPassword

Redis:
  host: 127.0.0.1
  port: 6379
  password: scheduleAdminPassword

RabbitMQ:
  host: 127.0.0.1
  port: 5672
  username: scheduleAdmin
  password: scheduleAdminPassword

logger:
  level: INFO

2. Initialize in main.py

import os
os_dir = os.path.dirname(__file__)
af = AstraFlux('config.yaml', os_dir)

Service Registration

  1. Create service file (e.g., test_server.py):

# -*- coding: utf-8 -*-

from nexusflow import *


class RpcFunction(ServiceConstructor):
    service_name = 'test_server'

    """All functions are automatically proxied for RPC calls"""

    def get_service_name(self):
        return {"service_version": self.service_version}

    def test_func(self, **args):
        return args

class WorkerFunction(WorkerConstructor):
    worker_name = 'test_server'

    def run(self, data):
        self.loguru.info(data)
        """
        Executed when new tasks appear in worker_name queue.
        Implement business logic here. `data` contains all task data.
        """
  1. Register the service in main.py

import test_server
af.registry(services=[test_server])

af.start()

Scheduled/Asynchronous Tasks

from nexusflow.interface import *

# Generate Snowflake ID
_id = snowflake_id()

# Create task
message = {'task_id': 'test_003', 'status': 'wait', 'name': 'xxxx'}
task_submit_databases(queue='test_server', message=message)

# Create subtasks (automatic status updates)
subtask_create(
    source_task_id='test_003',
    subtask_queue='test_server_sub',
    subtasks=[{
        'task_id': snowflake_id(),
        'name': 'subtask1',
    }]
)

# Stop task
task_stop(task_id='test_003')

# MongoDB interfaces
mongodb_task()     # Task operations
mongodb_node()     # Node operations
mongodb_services() # Service operations

# Redis interfaces
redis_task()
redis_services()

# RPC service call (auto load-balanced)
result = proxy_call(
    service_name='test_server',
    method_name='test_func',
    a=1, b=2  # Function arguments
)

Function Reference

from nexusflow.interface import *

# Generate Snowflake ID
_id = snowflake_id()

# Create task
message = {'task_id': 'test_003', 'status': 'wait', 'name': 'xxxx'}
task_submit_databases(queue='test_server', message=message)

# Create subtasks (automatic status updates)
subtask_create(
    source_task_id='test_003',
    subtask_queue='test_server_sub',
    subtasks=[{
        'task_id': snowflake_id(),
        'name': 'subtask1',
    }]
)

# Stop task
task_stop(task_id='test_003')

# MongoDB interfaces
mongodb_task()     # Task operations
mongodb_node()     # Node operations
mongodb_services() # Service operations

# Redis interfaces
redis_task()
redis_services()

# RPC service call (auto load-balanced)
result = proxy_call(
    service_name='test_server',
    method_name='test_func',
    a=1, b=2  # Function arguments
)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

astraflux-1.0.6.tar.gz (38.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

astraflux-1.0.6-py3-none-any.whl (52.4 kB view details)

Uploaded Python 3

File details

Details for the file astraflux-1.0.6.tar.gz.

File metadata

  • Download URL: astraflux-1.0.6.tar.gz
  • Upload date:
  • Size: 38.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for astraflux-1.0.6.tar.gz
Algorithm Hash digest
SHA256 42cdca59d1af26d55c865adb4d489a8cda89137618c800eb81fdfadd95d9fa3e
MD5 93dfade80b51b8b42e1f2de5fe897a6d
BLAKE2b-256 e036e538d4707b8b78aacbd2325713b324c79f56b329637ee8c7c50a450506e1

See more details on using hashes here.

File details

Details for the file astraflux-1.0.6-py3-none-any.whl.

File metadata

  • Download URL: astraflux-1.0.6-py3-none-any.whl
  • Upload date:
  • Size: 52.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for astraflux-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 a539c2c01f1533dcfe17978e017ade533f7d4736034440b3ee5ea55bfea68f10
MD5 e897d4302af8b07ffff7453ae14e8be3
BLAKE2b-256 18e0b3844bdf8f442be879fd0b563d6c59e9d1b00c1cd45c51d0b2caba45067a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page