edc-sites
Site definitions to work with Django’s Sites Framework and django_multisite.
Define a sites.py. This is usually in a separate project module. For example, for project meta there is a module meta_sites that contains a sites.py.
Register your sites in sites.py.
# sites.py
from edc_sites.site import sites
from edc_sites.single_site import SingleSite
suffix = "example.clinicedc.org"
sites.register(
SingleSite(
10,
"hindu_mandal",
title="Hindu Mandal Hospital",
country="tanzania",
country_code="tz",
domain=f"hindu_mandal.tz.{suffix}",
),
SingleSite(
20,
"amana",
title="Amana Hospital",
country="tanzania",
country_code="tz",
domain=f"amana.tz.{suffix}",
),
)
A post_migrate signal is registered in apps.py to update the django model Site and the EDC model SiteProfile on the next migration:
# apps.py
from edc_sites.add_or_update_django_sites import add_or_update_django_sites
def post_migrate_update_sites(sender=None, **kwargs):
sys.stdout.write(style.MIGRATE_HEADING("Updating sites:\n"))
add_or_update_django_sites(verbose=True)
sys.stdout.write("Done.\n")
sys.stdout.flush()
Now in your code you can use the sites global to inspect the trial sites:
from edc_sites.site import sites
In [1]: sites.all()
Out[1]:
{10: SingleSite(site_id=10, name='hindu_mandal', domain='hindu_mandal.tz.example.clinicedc.org', country='tanzania', description='Hindu Mandal Hospital'),
20: SingleSite(site_id=20, name='amana', domain='amana.tz.example.clinicedc.org', country='tanzania', description='Amana Hospital')}
In [2]: sites.get(10)
Out[2]: SingleSite(site_id=10, name='hindu_mandal', domain='hindu_mandal.tz.example.clinicedc.org', country='tanzania', description='Hindu Mandal Hospital')
In [3]: sites.get_by_attr("name", 'hindu_mandal')
Out[3]: SingleSite(site_id=10, name='hindu_mandal', domain='hindu_mandal.tz.example.clinicedc.org', country='tanzania', description='Hindu Mandal Hospital')
In [4]: sites.get(10).languages
Out[4]:
{'sw': 'Swahili',
'en-gb': 'British English',
'en': 'English',
'mas': 'Maasai',
'ry': 'Runyakitara',
'lg': 'Ganda',
'rny': 'Runyankore'}
Take a look at the Sites class in edc_sites.site for more available methods.
For another deployment, we have alot of sites spread out over a few countries.
For example:
from edc_sites.site import sites
from edc_sites.single_site import SingleSite
suffix = "inte.clinicedc.org"
sites.register(
SingleSite(
101,
"hindu_mandal",
title="Hindu Mandal Hospital",
country="tanzania",
country_code="tz",
domain=f"hindu_mandal.tz.{suffix}",
),
SingleSite(
102,
"amana",
title="Amana Hospital",
country="tanzania",
country_code="tz",
domain=f"amana.tz.{suffix}",
),
SingleSite(
201,
"kojja",
country="uganda",
country_code="ug",
domain=f"kojja.ug.{suffix}",
),
SingleSite(
202,
"mbarara",
country="uganda",
country_code="ug",
domain=f"mbarara.ug.{suffix}",
),
)
You can use the sites global to get the trial sites for a country:
from edc_sites.site import sites
In [1]: sites.get_by_country("uganda")
Out[1]:
{201: SingleSite(site_id=201, name='kojja', domain='kojja.ug.inte.clinicedc.org', country='uganda', description='Kojja'),
202: SingleSite(site_id=202, name='mbarara', domain='mbarara.ug.inte.clinicedc.org', country='uganda', description='Mbarara')}
In a multisite, multi-country deployment, managing the SITE_ID is complicated. We use django_multisite which nicely reads the SITE_ID from the url. django_multisite will extract kojja from https://kojja.ug.example.clinicedc.org to do a model lookup to get the SITE_ID.
Viewing data from multiple sites using view_auditallsites
The mixins provided by``edc_sites`` limit the EDC to only present data linked to the current site. To expand access beyond the current site, edc_sites provides a special permission codename; view_auditallsites. If a user has this permission, they will be shown data from the current site plus any additional sites granted in their user profile.
The permission codename view_auditallsites cannot be allocated to a user with add/edit/delete permissions to ANY model in the system. That is, the permission codename view_auditallsites is reserved for VIEW ONLY access, e.g the AUDITOR_ROLE. The one exception is for edc_auth and``auth`` models accessible to users granted ACCOUNT_MANAGER_ROLE permissions.
In your code, you can check if a user has access to more than just the current site using function may_view_other_sites:
if may_view_other_sites(request):
queryset = self.appointment_model_cls.objects.all()
else:
queryset = self.appointment_model_cls.on_site
To get a list of sites that the user has access to in the current request, use function get_view_only_site_ids_for_user.
from edc_model_admin.utils import add_to_messages_once
site_ids = get_view_only_site_ids_for_user(request.user, request.site, request=request)
Default Site and tests
Edc sites may be configured to register a default site. This may be useful for testing where you are not registering any sites manually or through autodiscover.
In settings:
EDC_SITES_REGISTER_DEFAULT=True
The default site id is 1.
If your tests depend on a test app that has a sites.py, you might need to set the SITE_ID in your tests.
Use the override_settings decorator on the test class or on a specific test.
For example:
@override_settings(SITE_ID=20)
class TestLpFormValidator(TestCase):
def setUp(self):
...
@override_settings(SITE_ID=40)
def test_lp_not_done(self):
...
Metadata
Release files for edc-sites 1.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| edc_sites-1.1.0.tar.gz | 50.2 kB | Without provenance | Details for edc_sites-1.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| edc_sites-1.1.0-py3-none-any.whl | Python 3 | none | any | Details for edc_sites-1.1.0-py3-none-any.whl |
Total release size: 109.3 kB
Release files / edc_sites-1.1.0.tar.gz
| Download URL | edc_sites-1.1.0.tar.gz |
|---|---|
| Size | 50.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bdece86c6ff62235012ce7dd759396745a2547b507d379189014b31103df2ef8
|
|
BLAKE2b-256 checksum How to use checksums |
206c8b23b1302ceb0c8f31255cef921e7ce7158369888690d66a7c1462cb55cf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.11
|
Release files / edc_sites-1.1.0-py3-none-any.whl
| Download URL | edc_sites-1.1.0-py3-none-any.whl |
|---|---|
| Size | 59.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
edc527aa3806f7b47c00388592882f5d3400b05818ac030568317b00637d863d
|
|
BLAKE2b-256 checksum How to use checksums |
a5fab006337398387b8fa872d8cca45720f3acf357966804ad51dea1cb2f8bc3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.11
|
Security for edc-sites 1.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.